doc: git mv to .md

* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <[email protected]> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · Apr 20, 2016 · 0800c0a · 0800c0a
1 parent cff2a13
commit 0800c0a
Show file tree

Hide file tree

Showing 50 changed files with 32 additions and 32 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -49,7 +49,7 @@ and built upon.
 #### Respect the stability index
 
 The rules for the master branch are less strict; consult the
-[stability index](./doc/api/documentation.markdown#stability-index) for details.
+[stability index](./doc/api/documentation..md#stability-index) for details.
 
 In a nutshell, modules are at varying levels of API stability. Bug fixes are
 always welcome but API or behavioral changes to modules at stability level 3

diff --git a/Makefile b/Makefile
@@ -131,7 +131,7 @@ test/gc/node_modules/weak/build/Release/weakref.node: $(NODE_EXE)
 		--nodedir="$(shell pwd)"
 
 # Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale.
-test/addons/.docbuildstamp: doc/api/addons.markdown
+test/addons/.docbuildstamp: doc/api/addons.md
 	$(RM) -r test/addons/??_*/
 	$(NODE) tools/doc/addon-verify.js
 	touch $@
@@ -247,9 +247,9 @@ test-v8 test-v8-intl test-v8-benchmarks test-v8-all:
 		"$ git clone https://github.com/nodejs/node.git"
 endif
 
-apidoc_sources = $(wildcard doc/api/*.markdown)
-apidocs = $(addprefix out/,$(apidoc_sources:.markdown=.html)) \
-		$(addprefix out/,$(apidoc_sources:.markdown=.json))
+apidoc_sources = $(wildcard doc/api/*.md)
+apidocs = $(addprefix out/,$(apidoc_sources:.md=.html)) \
+		$(addprefix out/,$(apidoc_sources:.md=.json))
 
 apidoc_dirs = out/doc out/doc/api/ out/doc/api/assets
 
@@ -266,10 +266,10 @@ out/doc/api/assets/%: doc/api_assets/% out/doc/api/assets/
 out/doc/%: doc/%
 	cp -r $< $@
 
-out/doc/api/%.json: doc/api/%.markdown $(NODE_EXE)
+out/doc/api/%.json: doc/api/%.md $(NODE_EXE)
 	$(NODE) tools/doc/generate.js --format=json $< > $@
 
-out/doc/api/%.html: doc/api/%.markdown $(NODE_EXE)
+out/doc/api/%.html: doc/api/%.md $(NODE_EXE)
 	$(NODE) tools/doc/generate.js --format=html --template=doc/template.html $< > $@
 
 docopen: out/doc/api/all.html

diff --git a/doc/api/_toc.markdown → doc/api/_toc.md b/doc/api/_toc.markdown → doc/api/_toc.md
diff --git a/doc/api/addons.markdown → doc/api/addons.md b/doc/api/addons.markdown → doc/api/addons.md
diff --git a/doc/api/all.markdown → doc/api/all.md b/doc/api/all.markdown → doc/api/all.md
diff --git a/doc/api/assert.markdown → doc/api/assert.md b/doc/api/assert.markdown → doc/api/assert.md
diff --git a/doc/api/buffer.markdown → doc/api/buffer.md b/doc/api/buffer.markdown → doc/api/buffer.md
@@ -764,8 +764,8 @@ console.log(buf2.compare(buf3));
   // produces sort order [buf1, buf3, buf2]
 ```
 
-The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd` 
-arguments can be used to limit the comparison to specific ranges within the two 
+The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`
+arguments can be used to limit the comparison to specific ranges within the two
 `Buffer` objects.
 
 ```js

diff --git a/doc/api/child_process.markdown → doc/api/child_process.md b/doc/api/child_process.markdown → doc/api/child_process.md
diff --git a/doc/api/cli.markdown → doc/api/cli.md b/doc/api/cli.markdown → doc/api/cli.md
diff --git a/doc/api/cluster.markdown → doc/api/cluster.md b/doc/api/cluster.markdown → doc/api/cluster.md
diff --git a/doc/api/console.markdown → doc/api/console.md b/doc/api/console.markdown → doc/api/console.md
@@ -110,7 +110,7 @@ console.assert(false, 'Whoops %s', 'didn\'t work');
 ```
 
 *Note: the `console.assert()` method is implemented differently in Node.js
-than the `console.assert()` method [available in browsers][web-api-assert].* 
+than the `console.assert()` method [available in browsers][web-api-assert].*
 
 Specifically, in browsers, calling `console.assert()` with a falsy
 assertion will cause the `message` to be printed to the console without

diff --git a/doc/api/crypto.markdown → doc/api/crypto.md b/doc/api/crypto.markdown → doc/api/crypto.md
diff --git a/doc/api/debugger.markdown → doc/api/debugger.md b/doc/api/debugger.markdown → doc/api/debugger.md
diff --git a/doc/api/dgram.markdown → doc/api/dgram.md b/doc/api/dgram.markdown → doc/api/dgram.md
diff --git a/doc/api/dns.markdown → doc/api/dns.md b/doc/api/dns.markdown → doc/api/dns.md
diff --git a/doc/api/documentation.markdown → doc/api/documentation.md b/doc/api/documentation.markdown → doc/api/documentation.md
@@ -16,7 +16,7 @@ experimental, and added for the benefit of IDEs and other utilities that
 wish to do programmatic things with the documentation.
 
 Every `.html` and `.json` file is generated based on the corresponding
-`.markdown` file in the `doc/api/` folder in Node.js's source tree.  The
+`.md` file in the `doc/api/` folder in Node.js's source tree.  The
 documentation is generated using the `tools/doc/generate.js` program.
 The HTML template is located at `doc/template.html`.
 

diff --git a/doc/api/domain.markdown → doc/api/domain.md b/doc/api/domain.markdown → doc/api/domain.md
diff --git a/doc/api/errors.markdown → doc/api/errors.md b/doc/api/errors.markdown → doc/api/errors.md
diff --git a/doc/api/events.markdown → doc/api/events.md b/doc/api/events.markdown → doc/api/events.md
diff --git a/doc/api/fs.markdown → doc/api/fs.md b/doc/api/fs.markdown → doc/api/fs.md
@@ -103,7 +103,7 @@ uses, working with paths as Buffers will be unnecessary, as the string
 API converts to and from UTF-8 automatically.
 
 *Note* that on certain file systems (such as NTFS and HFS+) filenames
-will always be encoded as UTF-8. On such file systems, passing 
+will always be encoded as UTF-8. On such file systems, passing
 non-UTF-8 encoded Buffers to `fs` functions will not work as expected.
 
 ## Class: fs.FSWatcher

diff --git a/doc/api/globals.markdown → doc/api/globals.md b/doc/api/globals.markdown → doc/api/globals.md
@@ -36,7 +36,7 @@ For instance, given two modules: `a` and `b`, where `b` is a dependency of
 * `/Users/mjr/app/a.js`
 * `/Users/mjr/app/node_modules/b/b.js`
 
-References to `__dirname` within `b.js` will return 
+References to `__dirname` within `b.js` will return
 `/Users/mjr/app/node_modules/b` while references to `__dirname` within `a.js`
 will return `/Users/mj/app`.
 

diff --git a/doc/api/http.markdown → doc/api/http.md b/doc/api/http.markdown → doc/api/http.md
diff --git a/doc/api/https.markdown → doc/api/https.md b/doc/api/https.markdown → doc/api/https.md
diff --git a/doc/api/index.markdown b/doc/api/index.markdown
diff --git a/doc/api/index.md b/doc/api/index.md
@@ -0,0 +1 @@
+@include _toc.md
diff --git a/doc/api/modules.markdown → doc/api/modules.md b/doc/api/modules.markdown → doc/api/modules.md
diff --git a/doc/api/net.markdown → doc/api/net.md b/doc/api/net.markdown → doc/api/net.md
diff --git a/doc/api/os.markdown → doc/api/os.md b/doc/api/os.markdown → doc/api/os.md
diff --git a/doc/api/path.markdown → doc/api/path.md b/doc/api/path.markdown → doc/api/path.md
diff --git a/doc/api/process.markdown → doc/api/process.md b/doc/api/process.markdown → doc/api/process.md
@@ -7,12 +7,12 @@ It is an instance of [`EventEmitter`][].
 
 ## Event: 'beforeExit'
 
-This event is emitted when Node.js empties its event loop and has nothing else 
-to schedule. Normally, Node.js exits when there is no work scheduled, but a 
-listener for `'beforeExit'` can make asynchronous calls, and cause Node.js to 
+This event is emitted when Node.js empties its event loop and has nothing else
+to schedule. Normally, Node.js exits when there is no work scheduled, but a
+listener for `'beforeExit'` can make asynchronous calls, and cause Node.js to
 continue.
 
-`'beforeExit'` is not emitted for conditions causing explicit termination, such 
+`'beforeExit'` is not emitted for conditions causing explicit termination, such
 as [`process.exit()`][] or uncaught exceptions, and should not be used as an
 alternative to the `'exit'` event unless the intention is to schedule more work.
 
@@ -93,7 +93,7 @@ indefinitely) or upon process exit (more convenient for scripts).
 ## Event: 'uncaughtException'
 
 The `'uncaughtException'` event is emitted when an exception bubbles all the
-way back to the event loop. By default, Node.js handles such exceptions by 
+way back to the event loop. By default, Node.js handles such exceptions by
 printing the stack trace to stderr and exiting. Adding a handler for the
 `'uncaughtException'` event overrides this default behavior.
 
@@ -145,7 +145,7 @@ a promise chain. This event is useful for detecting and keeping track of
 promises that were rejected whose rejections were not handled yet. This event
 is emitted with the following arguments:
 
- - `reason` the object with which the promise was rejected (usually an 
+ - `reason` the object with which the promise was rejected (usually an
    [`Error`][] instance).
  - `p` the promise that was rejected.
 
@@ -371,9 +371,9 @@ Note:
 
 - `SIGUSR1` is reserved by Node.js to start the debugger.  It's possible to
   install a listener but that won't stop the debugger from starting.
-- `SIGTERM` and `SIGINT` have default handlers on non-Windows platforms that 
-  resets the terminal mode before exiting with code `128 + signal number`. If 
-  one of these signals has a listener installed, its default behavior will be 
+- `SIGTERM` and `SIGINT` have default handlers on non-Windows platforms that
+  resets the terminal mode before exiting with code `128 + signal number`. If
+  one of these signals has a listener installed, its default behavior will be
   removed (Node.js will no longer exit).
 - `SIGPIPE` is ignored by default. It can have a listener installed.
 - `SIGHUP` is generated on Windows when the console window is closed, and on other
@@ -386,11 +386,11 @@ Note:
 - `SIGINT` from the terminal is supported on all platforms, and can usually be
   generated with `CTRL+C` (though this may be configurable). It is not generated
   when terminal raw mode is enabled.
-- `SIGBREAK` is delivered on Windows when `CTRL+BREAK` is pressed, on 
+- `SIGBREAK` is delivered on Windows when `CTRL+BREAK` is pressed, on
   non-Windows
   platforms it can be listened on, but there is no way to send or generate it.
-- `SIGWINCH` is delivered when the console has been resized. On Windows, this 
-  will only happen on write to the console when the cursor is being moved, or 
+- `SIGWINCH` is delivered when the console has been resized. On Windows, this
+  will only happen on write to the console when the cursor is being moved, or
   when a readable tty is used in raw mode.
 - `SIGKILL` cannot have a listener installed, it will unconditionally terminate
   Node.js on all platforms.

diff --git a/doc/api/punycode.markdown → doc/api/punycode.md b/doc/api/punycode.markdown → doc/api/punycode.md
diff --git a/doc/api/querystring.markdown → doc/api/querystring.md b/doc/api/querystring.markdown → doc/api/querystring.md
diff --git a/doc/api/readline.markdown → doc/api/readline.md b/doc/api/readline.markdown → doc/api/readline.md
diff --git a/doc/api/repl.markdown → doc/api/repl.md b/doc/api/repl.markdown → doc/api/repl.md
diff --git a/doc/api/stream.markdown → doc/api/stream.md b/doc/api/stream.markdown → doc/api/stream.md
diff --git a/doc/api/string_decoder.markdown → doc/api/string_decoder.md b/doc/api/string_decoder.markdown → doc/api/string_decoder.md
diff --git a/doc/api/synopsis.markdown → doc/api/synopsis.md b/doc/api/synopsis.markdown → doc/api/synopsis.md
diff --git a/doc/api/timers.markdown → doc/api/timers.md b/doc/api/timers.markdown → doc/api/timers.md
diff --git a/doc/api/tls.markdown → doc/api/tls.md b/doc/api/tls.markdown → doc/api/tls.md
diff --git a/doc/api/tty.markdown → doc/api/tty.md b/doc/api/tty.markdown → doc/api/tty.md
diff --git a/doc/api/url.markdown → doc/api/url.md b/doc/api/url.markdown → doc/api/url.md
diff --git a/doc/api/util.markdown → doc/api/util.md b/doc/api/util.markdown → doc/api/util.md
diff --git a/doc/api/v8.markdown → doc/api/v8.md b/doc/api/v8.markdown → doc/api/v8.md
diff --git a/doc/api/vm.markdown → doc/api/vm.md b/doc/api/vm.markdown → doc/api/vm.md
diff --git a/doc/api/zlib.markdown → doc/api/zlib.md b/doc/api/zlib.markdown → doc/api/zlib.md
diff --git a/src/node.cc b/src/node.cc
@@ -3376,7 +3376,7 @@ static bool ParseDebugOpt(const char* arg) {
 
 static void PrintHelp() {
   // XXX: If you add an option here, please also add it to doc/node.1 and
-  // doc/api/cli.markdown
+  // doc/api/cli.md
   printf("Usage: node [options] [ -e script | script.js ] [arguments] \n"
          "       node debug script.js [arguments] \n"
          "\n"

diff --git a/tools/doc/README.md b/tools/doc/README.md
@@ -1,6 +1,6 @@
 Here's how the node docs work.
 
-1:1 relationship from `lib/<module>.js` to `doc/api/<module>.markdown`
+1:1 relationship from `lib/<module>.js` to `doc/api/<module>.md`
 
 Each type of heading has a description block.
 

diff --git a/tools/doc/addon-verify.js b/tools/doc/addon-verify.js
@@ -5,7 +5,7 @@ const path = require('path');
 const marked = require('marked');
 
 const rootDir = path.resolve(__dirname, '..', '..');
-const doc = path.resolve(rootDir, 'doc', 'api', 'addons.markdown');
+const doc = path.resolve(rootDir, 'doc', 'api', 'addons.md');
 const verifyDir = path.resolve(rootDir, 'test', 'addons');
 
 const contents = fs.readFileSync(doc).toString();

diff --git a/tools/doc/html.js b/tools/doc/html.js
@@ -15,7 +15,7 @@ var gtocPath = path.resolve(path.join(
     '..',
     'doc',
     'api',
-    '_toc.markdown'
+    '_toc.md'
 ));
 var gtocLoading = null;
 var gtocData = null;
@@ -75,7 +75,7 @@ function render(lexed, filename, template, cb) {
   // get the section
   var section = getSection(lexed);
 
-  filename = path.basename(filename, '.markdown');
+  filename = path.basename(filename, '.md');
 
   parseText(lexed);
   lexed = parseLists(lexed);

diff --git a/tools/doc/preprocess.js b/tools/doc/preprocess.js
@@ -30,7 +30,7 @@ function processIncludes(inputFile, input, cb) {
   if (incCount === 0) cb(null, input);
   includes.forEach(function(include) {
     var fname = include.replace(/^@include\s+/, '');
-    if (!fname.match(/\.markdown$/)) fname += '.markdown';
+    if (!fname.match(/\.md$/)) fname += '.md';
 
     if (includeData.hasOwnProperty(fname)) {
       input = input.split(include).join(includeData[fname]);