@@ -30,7 +30,7 @@ nightlies or manual for releases) then moves the docs to
3030
3131** The key things to know about the tooling include:**
3232
33- 1 . It can be invoked via npx from the ` tools/doc ` directory (i.e. ` npx --prefix tools/doc doc-kit ...` )
33+ 1 . It can be invoked via executing ` tools/doc/node_modules/.bin/doc-kit ` (ex/ ` $ tools/doc/node_modules/.bin/ doc-kit generate ...` )
34342 . Its usage is detailed in the [ nodejs/doc-kit README] ( https://github.com/nodejs/doc-kit/blob/main/README.md ) .
35353 . The tooling can process multiple files at a time.
36364 . The tooling uses a set of dependencies as described in the dependencies
@@ -48,24 +48,24 @@ meant to be a guide on how to write documentation for Node.js.
4848
4949## Vocabulary & Good to Know's
5050
51- * AST means "Abstract Syntax Tree" and it is a data structure that represents
51+ - AST means "Abstract Syntax Tree" and it is a data structure that represents
5252 the structure of a certain data format. In our case, the AST is a "graph"
5353 representation of the contents of the Markdown file.
54- * MDN means [ Mozilla Developer Network] ( https://developer.mozilla.org/en-US/ )
54+ - MDN means [ Mozilla Developer Network] ( https://developer.mozilla.org/en-US/ )
5555 and it is a website that contains documentation for web technologies. We use
5656 it as a reference for the structure of the documentation.
57- * The
57+ - The
5858 [ Stability Index] ( https://nodejs.org/dist/latest/docs/api/documentation.html#stability-index )
5959 is used to community the Stability of a given Node.js module. The Stability
6060 levels include:
61- * Stability 0: Deprecated. (This module is Deprecated)
62- * Stability 1: Experimental. (This module is Experimental)
63- * Stability 2: Stable. (This module is Stable)
64- * Stability 3: Legacy. (This module is Legacy)
65- * Within Remark YAML snippets ` <!-- something --> ` are considered HTML nodes,
61+ - Stability 0: Deprecated. (This module is Deprecated)
62+ - Stability 1: Experimental. (This module is Experimental)
63+ - Stability 2: Stable. (This module is Stable)
64+ - Stability 3: Legacy. (This module is Legacy)
65+ - Within Remark YAML snippets ` <!-- something --> ` are considered HTML nodes,
6666 that's because YAML isn't valid Markdown content. (Doesn't abide by the
6767 Markdown spec)
68- * "New Tooling" references to the (written from-scratch) API build tooling
68+ - "New Tooling" references to the (written from-scratch) API build tooling
6969 introduced in ` nodejs/nodejs.dev ` that might replace the current one from
7070 ` nodejs/node `
7171
@@ -105,7 +105,7 @@ A description and examples.
105105added: v0.10.0
106106-->
107107
108- * {type}
108+ - {type}
109109
110110A description of the property.
111111
@@ -119,9 +119,9 @@ changes:
119119 description: A description of the change.
120120-->
121121
122- * `x` {string} The description of the string.
123- * `y` {boolean} Should I stay or should I go?
124- * `z` {number} How many zebras to bring. **Default:** `100`.
122+ - `x` {string} The description of the string.
123+ - `y` {boolean} Should I stay or should I go?
124+ - `z` {number} How many zebras to bring. **Default:** `100`.
125125
126126A description of the function.
127127
@@ -143,7 +143,7 @@ someFunction('a', true, 10);
143143added: REPLACEME
144144-->
145145
146- * `anArg` {type} A description of the listener argument.
146+ - `anArg` {type} A description of the listener argument.
147147
148148Modules don't usually raise events on themselves. `cluster` is the
149149only exception.
@@ -158,10 +158,10 @@ A description of the class.
158158added: v0.10.0
159159-->
160160
161- * `anArg` {Object} Just an argument.
162- * `field` {string} `anArg` can have this field.
163- * `field2` {boolean} Another field. **Default:** `false`.
164- * Returns: {boolean} `true` if it worked.
161+ - `anArg` {Object} Just an argument.
162+ - `field` {string} `anArg` can have this field.
163+ - `field2` {boolean} Another field. **Default:** `false`.
164+ - Returns: {boolean} `true` if it worked.
165165
166166A description of the method for humans.
167167
@@ -171,7 +171,7 @@ A description of the method for humans.
171171added: v0.10.0
172172-->
173173
174- * Returns: {SomeClass | null} The next `SomeClass` in line.
174+ - Returns: {SomeClass | null} The next `SomeClass` in line.
175175
176176`SomeClass` must be registered in `https://github.com/nodejs/doc-kit/blob/main/src/constants.mjs` to be properly parsed in `{type}` fields.
177177
@@ -181,7 +181,7 @@ added: v0.10.0
181181added: v0.10.0
182182-->
183183
184- * {string}
184+ - {string}
185185
186186The indication of what `someProperty` is.
187187
@@ -191,10 +191,9 @@ The indication of what `someProperty` is.
191191added: v0.10.0
192192-->
193193
194- * `isBlerg` {boolean}
194+ - `isBlerg` {boolean}
195195
196196This event is emitted on instances of `SomeClass`, not on the module itself.
197-
198197````
199198
200199[ `doc/api/` ] : https://github.com/nodejs/node/tree/main/doc/api
0 commit comments