Documenation Linting and TOC generation #3841
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| CHANGELOG.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| var remarkrc = { | ||
| settings: { | ||
| bullet: '*', | ||
| fence: '`', | ||
| strong: '*', | ||
| emphasis: '_', | ||
| listItemIndent: 1, | ||
| incrementListMarker: false | ||
| }, | ||
| plugins: { | ||
| 'toc': { | ||
| tight: true | ||
| }, | ||
| } | ||
| }; | ||
| var args = process.argv; | ||
|
|
||
| // only lint in non-output mode | ||
| if (args.indexOf('-o') === -1 && args.indexOf('--output') === -1) { | ||
| remarkrc['validate-links'] = {}; | ||
| remarkrc.plugins.lint = { | ||
| 'blockquote-indentation': ['error', 2], | ||
| 'checkbox-character-style': ['warn'], | ||
| 'checkbox-content-indent': ['error'], | ||
| 'code-block-style': ['error', 'fenced'], | ||
| 'definition-case': ['off'], | ||
| 'definition-spacing': ['error'], | ||
| 'emphasis-marker': ['error', '_'], | ||
| 'fenced-code-flag': ['error'], | ||
| 'fenced-code-marker': ['error', '`'], | ||
| 'file-extension': ['error'], | ||
| 'final-definition': ['error'], | ||
| 'final-newline': ['off'], | ||
| 'first-heading-level': ['warn', 1], | ||
| 'hard-break-spaces': ['off'], | ||
| 'heading-increment': ['error'], | ||
| 'heading-style': ['error', 'atx'], | ||
| 'link-title-style': ['warn', '"'], | ||
| 'list-item-bullet-indent': ['error'], | ||
| 'list-item-content-indent': ['warn'], | ||
| 'list-item-indent': ['error', 'space'], | ||
| 'list-item-spacing': ['off'], | ||
| 'maximum-heading-length': ['off'], | ||
| 'maximum-line-length': ['off'], | ||
| 'no-auto-link-without-protocol': ['error'], | ||
| 'no-blockquote-without-caret': ['error'], | ||
| 'no-consecutive-blank-lines': ['error'], | ||
| 'no-duplicate-definitions': ['error'], | ||
| 'no-duplicate-headings-in-section': ['error'], | ||
| 'no-duplicate-headings': ['off'], | ||
| 'no-emphasis-as-heading': ['error'], | ||
| 'no-file-name-articles': ['off'], | ||
| 'no-file-name-consecutive-dashes': ['off'], | ||
| 'no-file-name-irregular-characters': ['warn', '\\.a-zA-Z0-9-_'], | ||
| 'no-file-name-mixed-case': ['error'], | ||
| 'no-file-name-outer-dashes': ['error'], | ||
| 'no-heading-content-indent': ['error'], | ||
| 'no-heading-indent': ['error'], | ||
| 'no-heading-punctuation': ['off'], | ||
| 'no-html': ['off'], | ||
| 'no-inline-padding': ['error'], | ||
| 'no-literal-urls': ['off'], | ||
| 'no-missing-blank-lines': ['off'], | ||
| 'no-multiple-toplevel-headings': ['error'], | ||
| 'no-reference-like-url': ['error'], | ||
| 'no-shell-dollars': ['error'], | ||
| 'no-shortcut-reference-iamge': ['off'], | ||
| 'no-shortcut-reference-link': ['off'], | ||
| 'no-table-indentation': ['error'], | ||
| 'no-tabs': ['error'], | ||
| 'no-undefined-references': ['error'], | ||
| 'no-unused-definitions': ['error'], | ||
| 'ordered-list-marker-style': ['error', '.'], | ||
| 'ordered-list-marker-value': ['error', 'one'], | ||
| 'rule-style': ['error', '***'], | ||
| 'strong-marker': ['error', '*'], | ||
| 'table-cell-padding': ['warn', 'padded'], | ||
| 'table-cell-alignment': ['warn'], | ||
| 'table-pipes': ['warn'], | ||
| 'unordered-list-marker-style': ['warn', '*'] | ||
| }; | ||
| } | ||
|
|
||
| module.exports = remarkrc; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this a lot better than the doctoc mess. Does it key off the
## Table of Contentsheading or what?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah looks for the first heading called "Table of Contents". We could even rename the heading via an option. If we wanted to. Although I think Table of Contents makes the most sense.