@datalackey/update-markdown-toc 1.1.6 → 1.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -75,12 +75,13 @@ node_modules/.bin/ directory.
|
|
|
75
75
|
|
|
76
76
|
After installation, the `update-markdown-toc` command can be invoked in any
|
|
77
77
|
of the following ways from the project root (or a subdirectory) where the package was installed.
|
|
78
|
+
All examples below invoke the tool with the default README.md file as the TOC update target.
|
|
78
79
|
|
|
79
80
|
|
|
80
81
|
### Using npx (recommended)
|
|
81
82
|
|
|
82
83
|
```bash
|
|
83
|
-
npx update-markdown-toc
|
|
84
|
+
npx update-markdown-toc
|
|
84
85
|
````
|
|
85
86
|
|
|
86
87
|
|
|
@@ -91,7 +92,7 @@ You may also add a script entry to your package.json:
|
|
|
91
92
|
```json
|
|
92
93
|
{
|
|
93
94
|
"scripts": {
|
|
94
|
-
"docs:toc": "update-markdown-toc
|
|
95
|
+
"docs:toc": "update-markdown-toc"
|
|
95
96
|
}
|
|
96
97
|
}
|
|
97
98
|
```
|
|
@@ -104,7 +105,7 @@ npm run docs:toc
|
|
|
104
105
|
### Using a direct path (advanced)
|
|
105
106
|
|
|
106
107
|
```bash
|
|
107
|
-
./node_modules/.bin/update-markdown-toc
|
|
108
|
+
./node_modules/.bin/update-markdown-toc
|
|
108
109
|
```
|
|
109
110
|
|
|
110
111
|
|
|
@@ -284,12 +285,12 @@ This tool was designed in accordance with the top-level
|
|
|
284
285
|
[Build Philosophy](../../README.md#build-philosophy) of this repository.
|
|
285
286
|
|
|
286
287
|
|
|
287
|
-
- **update mode** (writes files: this should be run locally by developers, and should never run in CI)
|
|
288
|
+
- **update mode** (writes files: this should be run locally by developers, and should never run in CI. It is the default if `--check` not specified)
|
|
288
289
|
- **check mode** (validates and exits non-zero if stale: mainly intended to be run in CI -- optional for local use)
|
|
289
290
|
|
|
290
291
|
The intended workflow is:
|
|
291
292
|
|
|
292
|
-
1. Developers run the update
|
|
293
|
+
1. Developers run the command locally in default mode (update mode, a.k.a. non `--check` mode) in their workspace
|
|
293
294
|
2. Generated TOC content is reviewed and committed.
|
|
294
295
|
3. CI runs in `--check` mode to ensure no drift exists.
|
|
295
296
|
|
package/package.json
CHANGED