doc: add links to alternative versions of doc

Each page of the API documentation should have links to other versions of the same page. This will make it easier to switch between the current "live" release at nodejs.org and LTS versions. Backport-PR-URL: #15670 PR-URL: #10958 Fixes: #10726 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Sep 29, 2017 · ecea33b · ecea33b
1 parent 2c8fe97
commit ecea33b
Show file tree

Hide file tree

Showing 42 changed files with 196 additions and 5 deletions.
diff --git a/doc/api/addons.md b/doc/api/addons.md
@@ -1,5 +1,7 @@
 # C/C++ Addons
 
+<!--introduced_in=v0.10.0-->
+
 Node.js Addons are dynamically-linked shared objects, written in C or C++, that
 can be loaded into Node.js using the [`require()`][require] function, and used
 just as if they were an ordinary Node.js module. They are used primarily to

diff --git a/doc/api/assert.md b/doc/api/assert.md
@@ -1,5 +1,7 @@
 # Assert
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `assert` module provides a simple set of assertion tests that can be used to

diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -1,5 +1,7 @@
 # Buffer
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 Prior to the introduction of [`TypedArray`] in ECMAScript 2015 (ES6), the

diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -1,5 +1,7 @@
 # Child Process
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `child_process` module provides the ability to spawn child processes in

diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -1,5 +1,6 @@
 # Command Line Options
 
+<!--introduced_in=v5.9.1-->
 <!--type=misc-->
 
 Node.js comes with a variety of CLI options. These options expose built-in

diff --git a/doc/api/cluster.md b/doc/api/cluster.md
@@ -1,5 +1,7 @@
 # Cluster
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 A single instance of Node.js runs in a single thread. To take advantage of

diff --git a/doc/api/console.md b/doc/api/console.md
@@ -1,5 +1,7 @@
 # Console
 
+<!--introduced_in=v0.10.13-->
+
 > Stability: 2 - Stable
 
 The `console` module provides a simple debugging console that is similar to the

diff --git a/doc/api/crypto.md b/doc/api/crypto.md
@@ -1,5 +1,7 @@
 # Crypto
 
+<!--introduced_in=v0.3.6-->
+
 > Stability: 2 - Stable
 
 The `crypto` module provides cryptographic functionality that includes a set of

diff --git a/doc/api/debugger.md b/doc/api/debugger.md
@@ -1,5 +1,7 @@
 # Debugger
 
+<!--introduced_in=v0.9.12-->
+
 > Stability: 2 - Stable
 
 <!-- type=misc -->

diff --git a/doc/api/dgram.md b/doc/api/dgram.md
@@ -1,5 +1,7 @@
 # UDP / Datagram Sockets
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 <!-- name=dgram -->

diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -1,5 +1,7 @@
 # DNS
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `dns` module contains functions belonging to two different categories:

diff --git a/doc/api/documentation.md b/doc/api/documentation.md
@@ -1,5 +1,6 @@
 # About this Documentation
 
+<!--introduced_in=v0.10.0-->
 <!-- type=misc -->
 
 The goal of this documentation is to comprehensively explain the Node.js

diff --git a/doc/api/domain.md b/doc/api/domain.md
@@ -1,5 +1,7 @@
 # Domain
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 0 - Deprecated
 
 **This module is pending deprecation**. Once a replacement API has been

diff --git a/doc/api/errors.md b/doc/api/errors.md
@@ -1,5 +1,6 @@
 # Errors
 
+<!--introduced_in=v4.0.0-->
 <!--type=misc-->
 
 Applications running in Node.js will generally experience four categories of

diff --git a/doc/api/events.md b/doc/api/events.md
@@ -1,5 +1,7 @@
 # Events
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 <!--type=module-->

diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -1,5 +1,7 @@
 # File System
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 <!--name=fs-->

diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -1,5 +1,6 @@
 # Global Objects
 
+<!--introduced_in=v0.10.0-->
 <!-- type=misc -->
 
 These objects are available in all modules. Some of these objects aren't

diff --git a/doc/api/http.md b/doc/api/http.md
@@ -1,5 +1,7 @@
 # HTTP
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 To use the HTTP server and client one must `require('http')`.

diff --git a/doc/api/https.md b/doc/api/https.md
@@ -1,5 +1,7 @@
 # HTTPS
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a

diff --git a/doc/api/modules.md b/doc/api/modules.md
@@ -1,5 +1,7 @@
 # Modules
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 <!--name=module-->

diff --git a/doc/api/net.md b/doc/api/net.md
@@ -1,5 +1,7 @@
 # Net
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `net` module provides you with an asynchronous network wrapper. It contains

diff --git a/doc/api/os.md b/doc/api/os.md
@@ -1,5 +1,7 @@
 # OS
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `os` module provides a number of operating system-related utility methods.

diff --git a/doc/api/path.md b/doc/api/path.md
@@ -1,5 +1,7 @@
 # Path
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `path` module provides utilities for working with file and directory paths.

diff --git a/doc/api/process.md b/doc/api/process.md
@@ -1,5 +1,6 @@
 # Process
 
+<!-- introduced_in=v0.10.0 -->
 <!-- type=global -->
 
 The `process` object is a `global` that provides information about, and control

diff --git a/doc/api/punycode.md b/doc/api/punycode.md
@@ -1,5 +1,7 @@
 # Punycode
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 0 - Deprecated
 
 **The version of the punycode module bundled in Node.js is being deprecated**.

diff --git a/doc/api/querystring.md b/doc/api/querystring.md
@@ -1,5 +1,7 @@
 # Query String
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 <!--name=querystring-->

diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -1,5 +1,7 @@
 # Readline
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `readline` module provides an interface for reading data from a [Readable][]

diff --git a/doc/api/repl.md b/doc/api/repl.md
@@ -1,5 +1,7 @@
 # REPL
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `repl` module provides a Read-Eval-Print-Loop (REPL) implementation that

diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -1,5 +1,7 @@
 # Stream
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 A stream is an abstract interface for working with streaming data in Node.js.

diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md
@@ -1,5 +1,7 @@
 # String Decoder
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `string_decoder` module provides an API for decoding `Buffer` objects into

diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md
@@ -1,5 +1,6 @@
 # Usage
 
+<!--introduced_in=v0.10.0-->
 <!--type=misc-->
 
 `node [options] [v8 options] [script.js | -e "script"] [arguments]`

diff --git a/doc/api/timers.md b/doc/api/timers.md
@@ -1,5 +1,7 @@
 # Timers
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `timer` module exposes a global API for scheduling functions to

diff --git a/doc/api/tls.md b/doc/api/tls.md
@@ -1,5 +1,7 @@
 # TLS (SSL)
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `tls` module provides an implementation of the Transport Layer Security

diff --git a/doc/api/tty.md b/doc/api/tty.md
@@ -1,5 +1,7 @@
 # TTY
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes.

diff --git a/doc/api/url.md b/doc/api/url.md
@@ -1,5 +1,7 @@
 # URL
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `url` module provides utilities for URL resolution and parsing. It can be

diff --git a/doc/api/util.md b/doc/api/util.md
@@ -1,5 +1,7 @@
 # Util
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `util` module is primarily designed to support the needs of Node.js' own

diff --git a/doc/api/v8.md b/doc/api/v8.md
@@ -1,5 +1,7 @@
 # V8
 
+<!--introduced_in=v4.0.0-->
+
 The `v8` module exposes APIs that are specific to the version of [V8][]
 built into the Node.js binary. It can be accessed using:
 

diff --git a/doc/api/vm.md b/doc/api/vm.md
@@ -1,5 +1,7 @@
 # VM (Executing JavaScript)
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 <!--name=vm-->

diff --git a/doc/api/zlib.md b/doc/api/zlib.md
@@ -1,5 +1,7 @@
 # Zlib
 
+<!--introduced_in=v0.10.0-->
+
 > Stability: 2 - Stable
 
 The `zlib` module provides compression functionality implemented using Gzip and

diff --git a/doc/api_assets/style.css b/doc/api_assets/style.css
@@ -81,6 +81,61 @@ em code {
 
 #gtoc {
   font-size: .8em;
+  margin-bottom: 1em;
+}
+
+#gtoc ul {
+  list-style: none;
+  margin-left: 0;
+}
+
+#gtoc li {
+  display: inline;
+}
+
+li.version-picker {
+  position: relative;
+}
+
+li.version-picker:hover > ol {
+  display: block;
+}
+
+li.version-picker a span {
+  font-size: .7em;
+}
+
+ol.version-picker {
+  background: #fff;
+  border: 1px #43853d solid;
+  border-radius: 2px;
+  display: none;
+  list-style: none;
+  position: absolute;
+  right: -2px;
+  width: 101%;
+}
+
+#gtoc ol.version-picker li {
+  display: block;
+}
+
+ol.version-picker li a {
+  border-radius: 0;
+  display: block;
+  margin: 0;
+  padding: .1em;
+  padding-left: 1em;
+}
+
+ol.version-picker li:first-child a {
+  border-top-right-radius: 1px;
+  border-top-left-radius: 1px;
+}
+
+ol.version-picker li:last-child a {
+  border-bottom-right-radius: 1px;
+  border-bottom-left-radius: 1px;
 }
 
 .line {
@@ -496,6 +551,9 @@ th > *:last-child, td > *:last-child {
   #content {
     font-size: 3.5em;
   }
+  #gtoc {
+    font-size: 0.6em;
+  }
 }
 
 @media print {