Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions internal/rules/MDS001-line-length/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: Line exceeds maximum length.

Line exceeds maximum length.

- **ID**: MDS001
- **Name**: `line-length`
- **Status**: ready
- **Default**: enabled, max: 80
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: line

## Settings

| Setting | Type | Default | Description |
Expand Down Expand Up @@ -246,3 +237,14 @@ This line inside a code block is over 80 characters but within the code-block-ma
````

<?/include?>

## Meta-Information

- **ID**: MDS001
- **Name**: `line-length`
- **Status**: ready
- **Default**: enabled, max: 80
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: line
20 changes: 11 additions & 9 deletions internal/rules/MDS002-heading-style/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: Heading style must be consistent.

Heading style must be consistent.

- **ID**: MDS002
- **Name**: `heading-style`
- **Status**: ready
- **Default**: enabled, style: atx
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: heading

## Settings

| Setting | Type | Default | Description |
Expand Down Expand Up @@ -145,3 +136,14 @@ Body text.
|----------------------------------|---------------------------------------------|
| `heading style should be atx` | `style: atx` and a Setext heading is found |
| `heading style should be setext` | `style: setext` and an ATX heading is found |

## Meta-Information

- **ID**: MDS002
- **Name**: `heading-style`
- **Status**: ready
- **Default**: enabled, style: atx
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: heading
20 changes: 11 additions & 9 deletions internal/rules/MDS003-heading-increment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: Heading levels should increment by one. No jumping from `#` to `###

Heading levels should increment by one. No jumping from `#` to `###`.

- **ID**: MDS003
- **Name**: `heading-increment`
- **Status**: ready
- **Default**: enabled
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: heading

## Config

Enable:
Expand Down Expand Up @@ -66,3 +57,14 @@ Body text.
```

<?/include?>

## Meta-Information

- **ID**: MDS003
- **Name**: `heading-increment`
- **Status**: ready
- **Default**: enabled
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: heading
20 changes: 11 additions & 9 deletions internal/rules/MDS004-first-line-heading/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: First line of the file should be a heading.

First line of the file should be a heading.

- **ID**: MDS004
- **Name**: `first-line-heading`
- **Status**: ready
- **Default**: enabled, level: 1
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: heading

## Settings

| Setting | Type | Default | Description |
Expand Down Expand Up @@ -104,3 +95,14 @@ Some content here.
| `first line should be a level {level} heading` | Line 1 is missing or not a heading |
| `first line should be a level {level} heading, found blank line` | First child is a heading but preceded by blank line |
| `first heading should be level {level}, got {n}` | First heading on line 1 has the wrong level |

## Meta-Information

- **ID**: MDS004
- **Name**: `first-line-heading`
- **Status**: ready
- **Default**: enabled, level: 1
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: heading
20 changes: 11 additions & 9 deletions internal/rules/MDS005-no-duplicate-headings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: No two headings should have the same text.

No two headings should have the same text.

- **ID**: MDS005
- **Name**: `no-duplicate-headings`
- **Status**: ready
- **Default**: enabled
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: heading

## Config

Enable:
Expand Down Expand Up @@ -72,3 +63,14 @@ Body two.
```

<?/include?>

## Meta-Information

- **ID**: MDS005
- **Name**: `no-duplicate-headings`
- **Status**: ready
- **Default**: enabled
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: heading
20 changes: 11 additions & 9 deletions internal/rules/MDS006-no-trailing-spaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: No trailing whitespace at the end of lines.

No trailing whitespace at the end of lines.

- **ID**: MDS006
- **Name**: `no-trailing-spaces`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace

## Config

Enable:
Expand Down Expand Up @@ -68,3 +59,14 @@ code block with language tag
````

<?/include?>

## Meta-Information

- **ID**: MDS006
- **Name**: `no-trailing-spaces`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace
20 changes: 11 additions & 9 deletions internal/rules/MDS007-no-hard-tabs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: No tab characters. Use spaces instead.

No tab characters. Use spaces instead.

- **ID**: MDS007
- **Name**: `no-hard-tabs`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace

## Config

Enable:
Expand Down Expand Up @@ -69,3 +60,14 @@ No tabs here.
````

<?/include?>

## Meta-Information

- **ID**: MDS007
- **Name**: `no-hard-tabs`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace
20 changes: 11 additions & 9 deletions internal/rules/MDS008-no-multiple-blanks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: No more than one consecutive blank line.

No more than one consecutive blank line.

- **ID**: MDS008
- **Name**: `no-multiple-blanks`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace

## Config

Enable:
Expand Down Expand Up @@ -72,3 +63,14 @@ more code with blank lines above
````

<?/include?>

## Meta-Information

- **ID**: MDS008
- **Name**: `no-multiple-blanks`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace
20 changes: 11 additions & 9 deletions internal/rules/MDS009-single-trailing-newline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: File must end with exactly one newline character.

File must end with exactly one newline character.

- **ID**: MDS009
- **Name**: `single-trailing-newline`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace

## Config

Enable:
Expand Down Expand Up @@ -72,3 +63,14 @@ The `<?include?>` output looks identical because the
wrap always adds a newline, but the actual fixture file
(`bad/default.md`) ends without one — that missing byte
is what the rule detects.

## Meta-Information

- **ID**: MDS009
- **Name**: `single-trailing-newline`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: whitespace
20 changes: 11 additions & 9 deletions internal/rules/MDS010-fenced-code-style/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: Fenced code blocks must use a consistent delimiter.

Fenced code blocks must use a consistent delimiter.

- **ID**: MDS010
- **Name**: `fenced-code-style`
- **Status**: ready
- **Default**: enabled, style: backtick
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: code

## Settings

| Setting | Type | Default | Description |
Expand Down Expand Up @@ -117,3 +108,14 @@ fmt.Println("hello")
````

<?/include?>

## Meta-Information

- **ID**: MDS010
- **Name**: `fenced-code-style`
- **Status**: ready
- **Default**: enabled, style: backtick
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: code
20 changes: 11 additions & 9 deletions internal/rules/MDS011-fenced-code-language/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: Fenced code blocks must specify a language.

Fenced code blocks must specify a language.

- **ID**: MDS011
- **Name**: `fenced-code-language`
- **Status**: ready
- **Default**: enabled
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: code

## Config

Enable:
Expand Down Expand Up @@ -68,3 +59,14 @@ fmt.Println("hello")
````

<?/include?>

## Meta-Information

- **ID**: MDS011
- **Name**: `fenced-code-language`
- **Status**: ready
- **Default**: enabled
- **Fixable**: no
- **Implementation**:
[source](./)
- **Category**: code
20 changes: 11 additions & 9 deletions internal/rules/MDS012-no-bare-urls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ description: URLs must be wrapped in angle brackets or as a link, not left bare.

URLs must be wrapped in angle brackets or as a link, not left bare.

- **ID**: MDS012
- **Name**: `no-bare-urls`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: link

## Config

Enable:
Expand Down Expand Up @@ -64,3 +55,14 @@ Visit [example](https://example.com) for more.
```

<?/include?>

## Meta-Information

- **ID**: MDS012
- **Name**: `no-bare-urls`
- **Status**: ready
- **Default**: enabled
- **Fixable**: yes
- **Implementation**:
[source](./)
- **Category**: link
Loading
Loading