Skip to content

Commit

Permalink
doc: git mv to .md
Browse files Browse the repository at this point in the history
Original commit:
0800c0a

    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 <myles.borins@gmail.com>
    Reviewed-By: techjeffharris
    Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
    Reviewed-By: James M Snell <jasnell@gmail.com>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
eljefedelrodeodeljefe authored and Myles Borins committed Jul 14, 2016
1 parent fb03e57 commit c237ac3
Show file tree
Hide file tree
Showing 50 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,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 $@
Expand Down Expand Up @@ -249,9 +249,9 @@ test-v8-benchmarks:
test-v8-all: test-v8 test-v8-intl test-v8-benchmarks
# runs all v8 tests

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

Expand All @@ -268,10 +268,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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion doc/api/index.markdown

This file was deleted.

1 change: 1 addition & 0 deletions doc/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@include _toc.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/node.cc
Original file line number Diff line number Diff line change
Expand Up @@ -3263,7 +3263,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"
Expand Down
2 changes: 1 addition & 1 deletion tools/doc/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion tools/doc/addon-verify.js
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
4 changes: 2 additions & 2 deletions tools/doc/html.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ var gtocPath = path.resolve(path.join(
'..',
'doc',
'api',
'_toc.markdown'
'_toc.md'
));
var gtocLoading = null;
var gtocData = null;
Expand Down Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion tools/doc/preprocess.js
Original file line number Diff line number Diff line change
Expand Up @@ -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]);
Expand Down

0 comments on commit c237ac3

Please sign in to comment.