|
| 1 | +# Markdown linting rules for Tech Notes Hub |
| 2 | +# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for details |
| 3 | + |
| 4 | +# Default state for all rules |
| 5 | +default: true |
| 6 | + |
| 7 | +# MD001 header-increment - Headers should increment by one level at a time |
| 8 | +MD001: true |
| 9 | + |
| 10 | +# MD003 header-style - Header style |
| 11 | +MD003: |
| 12 | + style: "atx" # Use # style headers |
| 13 | + |
| 14 | +# MD004 ul-style - Unordered list style |
| 15 | +MD004: |
| 16 | + style: "consistent" |
| 17 | + |
| 18 | +# MD007 ul-indent - Unordered list indentation |
| 19 | +MD007: |
| 20 | + indent: 2 # Use 2 spaces for indentation |
| 21 | + |
| 22 | +# MD009 no-trailing-spaces - No trailing spaces |
| 23 | +MD009: true |
| 24 | + |
| 25 | +# MD010 no-hard-tabs - No hard tabs |
| 26 | +MD010: true |
| 27 | + |
| 28 | +# MD012 no-multiple-blanks - Multiple consecutive blank lines |
| 29 | +MD012: |
| 30 | + maximum: 1 # Allow at most 1 blank line |
| 31 | + |
| 32 | +# MD013 line-length - Line length |
| 33 | +MD013: |
| 34 | + line_length: 120 # Allow longer lines for code blocks |
| 35 | + code_blocks: false |
| 36 | + tables: false |
| 37 | + |
| 38 | +# MD022 blanks-around-headers - Headers should be surrounded by blank lines |
| 39 | +MD022: true |
| 40 | + |
| 41 | +# MD024 no-duplicate-header - Multiple headers with the same content |
| 42 | +MD024: |
| 43 | + siblings_only: true # Allow same title in different nesting |
| 44 | + |
| 45 | +# MD025 single-title/single-h1 - Only one top-level header |
| 46 | +MD025: true |
| 47 | + |
| 48 | +# MD026 no-trailing-punctuation - No trailing punctuation in header |
| 49 | +MD026: |
| 50 | + punctuation: ".,;:!。,;:!" |
| 51 | + |
| 52 | +# MD029 ol-prefix - Ordered list item prefix |
| 53 | +MD029: |
| 54 | + style: "one_or_ordered" # Use 1. or ordered numbers |
| 55 | + |
| 56 | +# MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines |
| 57 | +MD031: true |
| 58 | + |
| 59 | +# MD032 blanks-around-lists - Lists should be surrounded by blank lines |
| 60 | +MD032: true |
| 61 | + |
| 62 | +# MD033 no-inline-html - No inline HTML |
| 63 | +MD033: |
| 64 | + allowed_elements: ["br", "img", "a", "details", "summary"] |
| 65 | + |
| 66 | +# MD034 no-bare-urls - No bare URLs |
| 67 | +MD034: true |
| 68 | + |
| 69 | +# MD036 no-emphasis-as-header - No emphasis as header |
| 70 | +MD036: true |
| 71 | + |
| 72 | +# MD037 no-space-in-emphasis - No spaces inside emphasis markers |
| 73 | +MD037: true |
| 74 | + |
| 75 | +# MD038 no-space-in-code - No spaces inside code span markers |
| 76 | +MD038: true |
| 77 | + |
| 78 | +# MD040 fenced-code-language - Fenced code blocks should have a language specified |
| 79 | +MD040: true |
| 80 | + |
| 81 | +# MD041 first-line-heading - First line should be a top-level header |
| 82 | +MD041: true |
| 83 | + |
| 84 | +# MD046 code-block-style - Code block style |
| 85 | +MD046: |
| 86 | + style: "fenced" # Use ```code``` style |
0 commit comments