@datalackey/update-markdown-toc 1.0.0 → 1.0.1
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 +18 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- TOC:START -->
|
|
4
4
|
- [update-markdown-toc](#update-markdown-toc)
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
5
|
+
- [Introduction](#introduction)
|
|
6
|
+
- [Installation](#installation)
|
|
7
|
+
- [Usage](#usage)
|
|
8
|
+
- [Using npx (recommended)](#using-npx-recommended)
|
|
9
|
+
- [Using npm scripts](#using-npm-scripts)
|
|
10
|
+
- [Using a direct path (advanced)](#using-a-direct-path-advanced)
|
|
11
|
+
- [Options](#options)
|
|
12
|
+
- [TOC Markers](#toc-markers)
|
|
13
|
+
- [Usage Scenarios](#usage-scenarios)
|
|
14
|
+
- [As Part of code/test/debug Work Flow](#as-part-of-codetestdebug-work-flow)
|
|
15
|
+
- [Continuous Integration](#continuous-integration)
|
|
16
|
+
- [Recursively Traversing a Folder Hierarchy to Process all files vs. Single File Processing](#recursively-traversing-a-folder-hierarchy-to-process-all-files-vs-single-file-processing)
|
|
17
|
+
- [Single-File Processing (Strict Mode)](#single-file-processing-strict-mode)
|
|
18
|
+
- [Recursive Folder Traversal (Lenient Mode)](#recursive-folder-traversal-lenient-mode)
|
|
19
|
+
- [Guidelines For Project Contributors](#guidelines-for-project-contributors)
|
|
20
20
|
<!-- TOC:END -->
|
|
21
21
|
|
|
22
22
|
## Introduction
|
|
@@ -189,18 +189,12 @@ the tool operates in strict mode.
|
|
|
189
189
|
In this mode, any of the following conditions cause an immediate error and a non-zero exit code:
|
|
190
190
|
|
|
191
191
|
- file does not exist, or cannot be read (e.g. due to permissions).
|
|
192
|
-
- file does not contain both TOC delimiters (
|
|
192
|
+
- file does not contain both TOC delimiters ({!-- TOC:START --} and {!-- TOC:END --}).
|
|
193
|
+
(See [TOC markers](#toc-markers) section about how we describe markers in this guide.)
|
|
193
194
|
- file is stale (i.e. the existing TOC differs from the generated TOC).
|
|
194
|
-
-
|
|
195
|
+
- file contains TOC delimiters but no Markdown headings are found from which a TOC can be generated.
|
|
195
196
|
|
|
196
197
|
|
|
197
|
-
|
|
198
|
-
```md
|
|
199
|
-
{!-- TOC:START --}
|
|
200
|
-
{!-- TOC:END --}
|
|
201
|
-
|
|
202
|
-
```
|
|
203
|
-
|
|
204
198
|
If either marker is missing, the tool prints an error message and exits with a non-zero status code.
|
|
205
199
|
|
|
206
200
|
|
package/package.json
CHANGED