-
Notifications
You must be signed in to change notification settings - Fork 684
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
- Loading branch information
Showing
271 changed files
with
6,425 additions
and
4,586 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| # Default state for all rules | ||
| default: true | ||
|
|
||
| # Path to configuration file to extend | ||
| extends: null | ||
|
|
||
| # MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time | ||
| MD001: true | ||
|
|
||
| # MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading | ||
| MD002: | ||
| # Heading level | ||
| level: 1 | ||
|
|
||
| # MD003/heading-style/header-style - Heading style | ||
| MD003: | ||
| # Heading style | ||
| style: "consistent" | ||
|
|
||
| # MD004/ul-style - Unordered list style | ||
| MD004: | ||
| # List style | ||
| style: "consistent" | ||
|
|
||
| # MD005/list-indent - Inconsistent indentation for list items at the same level | ||
| MD005: false | ||
|
|
||
| # MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line | ||
| MD006: false | ||
|
|
||
| # MD007/ul-indent - Unordered list indentation | ||
| MD007: false | ||
|
|
||
| # MD009/no-trailing-spaces - Trailing spaces | ||
| MD009: | ||
| # Spaces for line break | ||
| br_spaces: 2 | ||
| # Allow spaces for empty lines in list items | ||
| list_item_empty_lines: false | ||
| # Include unnecessary breaks | ||
| strict: false | ||
|
|
||
| # MD010/no-hard-tabs - Hard tabs | ||
| MD010: false | ||
|
|
||
| # MD011/no-reversed-links - Reversed link syntax | ||
| MD011: true | ||
|
|
||
| # MD012/no-multiple-blanks - Multiple consecutive blank lines | ||
| MD012: | ||
| # Consecutive blank lines | ||
| maximum: 2 | ||
|
|
||
| # MD013/line-length - Line length | ||
| MD013: | ||
| # Number of characters | ||
| line_length: 120 | ||
| # Number of characters for headings | ||
| heading_line_length: 120 | ||
| # Number of characters for code blocks | ||
| code_block_line_length: 150 | ||
| # Include code blocks | ||
| code_blocks: true | ||
| # Include tables | ||
| tables: true | ||
| # Include headings | ||
| headings: true | ||
| # Include headings | ||
| headers: true | ||
| # Strict length checking | ||
| strict: false | ||
| # Stern length checking | ||
| stern: false | ||
|
|
||
| # MD014/commands-show-output - Dollar signs used before commands without showing output | ||
| MD014: true | ||
|
|
||
| # MD018/no-missing-space-atx - No space after hash on atx style heading | ||
| MD018: true | ||
|
|
||
| # MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading | ||
| MD019: true | ||
|
|
||
| # MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading | ||
| MD020: true | ||
|
|
||
| # MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading | ||
| MD021: true | ||
|
|
||
| # MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines | ||
| MD022: false | ||
|
|
||
| # MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line | ||
| MD023: true | ||
|
|
||
| # MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content | ||
| MD024: false | ||
|
|
||
| # MD025/single-title/single-h1 - Multiple top-level headings in the same document | ||
| MD025: false | ||
|
|
||
| # MD026/no-trailing-punctuation - Trailing punctuation in heading | ||
| MD026: | ||
| # Punctuation characters | ||
| punctuation: ".,;:!。，；：！" | ||
|
|
||
| # MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol | ||
| MD027: true | ||
|
|
||
| # MD028/no-blanks-blockquote - Blank line inside blockquote | ||
| MD028: true | ||
|
|
||
| # MD029/ol-prefix - Ordered list item prefix | ||
| MD029: | ||
| # List style | ||
| style: "one_or_ordered" | ||
|
|
||
| # MD030/list-marker-space - Spaces after list markers | ||
| MD030: | ||
| # Spaces for single-line unordered list items | ||
| ul_single: 1 | ||
| # Spaces for single-line ordered list items | ||
| ol_single: 1 | ||
| # Spaces for multi-line unordered list items | ||
| ul_multi: 1 | ||
| # Spaces for multi-line ordered list items | ||
| ol_multi: 1 | ||
|
|
||
| # MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines | ||
| MD031: false | ||
|
|
||
| # MD032/blanks-around-lists - Lists should be surrounded by blank lines | ||
| MD032: false | ||
|
|
||
| # MD033/no-inline-html - Inline HTML | ||
| MD033: false | ||
|
|
||
| # MD034/no-bare-urls - Bare URL used | ||
| MD034: false | ||
|
|
||
| # MD035/hr-style - Horizontal rule style | ||
| MD035: | ||
| # Horizontal rule style | ||
| style: "consistent" | ||
|
|
||
| # MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading | ||
| MD036: false | ||
|
|
||
| # MD037/no-space-in-emphasis - Spaces inside emphasis markers | ||
| MD037: true | ||
|
|
||
| # MD038/no-space-in-code - Spaces inside code span elements | ||
| MD038: true | ||
|
|
||
| # MD039/no-space-in-links - Spaces inside link text | ||
| MD039: true | ||
|
|
||
| # MD040/fenced-code-language - Fenced code blocks should have a language specified | ||
| MD040: false | ||
|
|
||
| # MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading | ||
| MD041: false | ||
|
|
||
| # MD042/no-empty-links - No empty links | ||
| MD042: true | ||
|
|
||
| # MD043/required-headings/required-headers - Required heading structure | ||
| MD043: false | ||
|
|
||
| # MD044/proper-names - Proper names should have the correct capitalization | ||
| MD044: | ||
| # List of proper names | ||
| names: ["Polkadot", "Substrate", "Cumulus", "Parity"] | ||
| # Include code blocks | ||
| code_blocks: false | ||
| # Include HTML elements | ||
| html_elements: false | ||
|
|
||
| # MD045/no-alt-text - Images should have alternate text (alt text) | ||
| MD045: false | ||
|
|
||
| # MD046/code-block-style - Code block style | ||
| MD046: | ||
| # Block style | ||
| style: "consistent" | ||
|
|
||
| # MD047/single-trailing-newline - Files should end with a single newline character | ||
| MD047: true | ||
|
|
||
| # MD048/code-fence-style - Code fence style | ||
| MD048: | ||
| # Code fence style | ||
| style: "consistent" | ||
|
|
||
| # MD049/emphasis-style - Emphasis style should be consistent | ||
| MD049: false | ||
|
|
||
| # MD050/strong-style - Strong style should be consistent | ||
| MD050: | ||
| # Strong style | ||
| style: "consistent" | ||
|
|
||
| # MD051/link-fragments - Link fragments should be valid | ||
| MD051: false | ||
|
|
||
| # MD052/reference-links-images - Reference links and images should use a label that is defined | ||
| MD052: false | ||
|
|
||
| # MD053/link-image-reference-definitions - Link and image reference definitions should be needed | ||
| MD053: false |
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,33 @@ | ||
| name: Check Markdown | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
|
|
||
| permissions: | ||
| packages: read | ||
|
|
||
| jobs: | ||
| lint-markdown: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - uses: actions/setup-node@v3.8.1 | ||
| with: | ||
| node-version: "18.x" | ||
| registry-url: "https://npm.pkg.github.com" | ||
| scope: "@paritytech" | ||
|
|
||
| - name: Install tooling | ||
| run: | | ||
| npm install -g markdownlint-cli | ||
| markdownlint --version | ||
| - name: Check Markdown | ||
| env: | ||
| CONFIG: .github/.markdownlint.yaml | ||
| run: | | ||
| markdownlint --config "$CONFIG" --ignore target . |
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.