First header should be a top level header Open
Changes proposed in this pull-request:
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MD002 - First header should be a top level header
Tags: headers
Aliases: first-header-h1
Parameters: level (number; default 1)
This rule is triggered when the first header in the document isn't a h1 header:
## This isn't a H1 header
### Another header
The first header in the document should be a h1 header:
# Start with a H1 header
## Then use a H2 for subsections
Trailing punctuation in header Open
Changes proposed in this pull-request:
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MD026 - Trailing punctuation in header
Tags: headers
Aliases: no-trailing-punctuation
Parameters: punctuation (string; default ".,;:!?")
This rule is triggered on any header that has a punctuation character as the last character in the line:
# This is a header.
To fix this, remove any trailing punctuation:
# This is a header
Note: The punctuation parameter can be used to specify what characters class
as punctuation at the end of the header. For example, you can set it to
'.,;:!'
to allow headers with question marks in them, such as might be used
in an FAQ.
Headers should be surrounded by blank lines Open
Changes proposed in this pull-request:
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MD022 - Headers should be surrounded by blank lines
Tags: headers, blank_lines
Aliases: blanks-around-headers
This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:
# Header 1
Some text
Some more text
## Header 2
To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):
# Header 1
Some text
Some more text
## Header 2
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.
First line in file should be a top level header Open
WIP: <Title>
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
MD041 - First line in file should be a top level header
Tags: headers
Aliases: first-line-h1
Parameters: level (number; default 1)
This rule is triggered when the first line in the file isn't a top level (h1) header:
```
This is a file without a header
```
To fix this, add a header to the top of your file:
```
# File with header
This is a file with a top level header
```
Note: The level
parameter can be used to change the top level (ex: to h2) in
cases where an h1 is added externally.