Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add links to alternative versions of doc #10958

Closed
wants to merge 10 commits into from
Closed
4 changes: 3 additions & 1 deletion doc/api/addons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# C++ Addons

Node.js Addons are dynamically-linked shared objects, written in C++, that
<!--introduced_in=v0.10.0-->

Node.js Addons are dynamically-linked shared objects, written in C or C++, that
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit explicitly changed this to C++ abfd4bf

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
provide an interface between JavaScript running in Node.js and C/C++ libraries.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Buffer

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

Prior to the introduction of [`TypedArray`] in ECMAScript 2015 (ES6), the
Expand Down
2 changes: 2 additions & 0 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/cluster.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/console.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Crypto

<!--introduced_in=v0.3.6-->

> Stability: 2 - Stable

The `crypto` module provides cryptographic functionality that includes a set of
Expand Down
2 changes: 2 additions & 0 deletions doc/api/debugger.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Debugger

<!--introduced_in=v0.9.12-->

> Stability: 2 - Stable

<!-- type=misc -->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/dgram.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# UDP / Datagram Sockets

<!--introduced_in=v0.10.0-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this one is correct, although I'm not sure we care since we are only going back to v0.10

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix this, it might not technically matter but it should be the correct version


> Stability: 2 - Stable

<!-- name=dgram -->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/dns.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# DNS

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

The `dns` module contains functions belonging to two different categories:
Expand Down
1 change: 1 addition & 0 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ changes:
the first promise of a chain was created.
-->

<!--introduced_in=v0.10.0-->

> Stability: 0 - Deprecated

**This module is pending deprecation**. Once a replacement API has been
Expand Down
1 change: 1 addition & 0 deletions doc/api/errors.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Errors

<!--introduced_in=v4.0.0-->
<!--type=misc-->

Applications running in Node.js will generally experience four categories of
Expand Down
2 changes: 2 additions & 0 deletions doc/api/events.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Events

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

<!--type=module-->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# File System

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

<!--name=fs-->
Expand Down
1 change: 1 addition & 0 deletions doc/api/globals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Global Objects

<!--introduced_in=v0.10.0-->
<!-- type=misc -->

These objects are available in all modules. The following variables may appear
Expand Down
2 changes: 2 additions & 0 deletions doc/api/http.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# HTTP

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

To use the HTTP server and client one must `require('http')`.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/https.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/modules.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Modules

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

<!--name=module-->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/net.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Net

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

The `net` module provides an asynchronous network API for creating stream-based
Expand Down
2 changes: 2 additions & 0 deletions doc/api/os.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/path.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions doc/api/process.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Process

<!-- introduced_in=v0.10.0 -->
<!-- type=global -->

The `process` object is a `global` that provides information about, and control
Expand Down
2 changes: 2 additions & 0 deletions doc/api/punycode.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ changes:
description: Accessing this module will now emit a deprecation warning.
-->

<!--introduced_in=v0.10.0-->

> Stability: 0 - Deprecated

**The version of the punycode module bundled in Node.js is being deprecated**.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/querystring.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Query String

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

<!--name=querystring-->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
@@ -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][]
Expand Down
2 changes: 2 additions & 0 deletions doc/api/repl.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/string_decoder.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/synopsis.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Usage

<!--introduced_in=v0.10.0-->
<!--type=misc-->

`node [options] [v8 options] [script.js | -e "script" | - ] [arguments]`
Expand Down
2 changes: 2 additions & 0 deletions doc/api/timers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Timers

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

The `timer` module exposes a global API for scheduling functions to
Expand Down
2 changes: 2 additions & 0 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/tty.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# TTY

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/url.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/util.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/api/v8.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 2 additions & 0 deletions doc/api/vm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# VM (Executing JavaScript)

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

<!--name=vm-->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/zlib.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Zlib

<!--introduced_in=v0.10.0-->

> Stability: 2 - Stable

The `zlib` module provides compression functionality implemented using Gzip and
Expand Down
22 changes: 22 additions & 0 deletions doc/api_assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,28 @@ em code {
font-size: .8em;
}

#alt-docs {
color: #666;
font-size: .75em;
}

#alt-docs a {
color: #666;
}

#alt-docs a:hover {
background: none;
text-decoration: underline;
}

#alt-docs a:active, #alt-docs a:link {
background: none;
}

#alt-docs b {
margin-left: .5em;
}

.line {
width: calc(100% - 1em);
display: block;
Expand Down
1 change: 1 addition & 0 deletions doc/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ <h1>Node.js __VERSION__ Documentation</h1>
</p>
</div>
<hr>
<div id="alt-docs">__ALTDOCS__</div>
</header>

<div id="toc">
Expand Down
Loading