Showing 292 of 292 total issues
Color literals like #aaa
should only be used in variable declarations; they should be referred to via variable everywhere else. Open
border-bottom: 1px #aaa dotted;
- Exclude checks
Properties should be ordered border-bottom, font-family, font-size, font-style, font-variant, font-weight, line-height, padding Open
padding: 10px 0;
- Exclude checks
Header style Open
Table of contents
- Read upRead up
- Exclude checks
MD003 - Header style
Tags: headers
Aliases: header-style
Parameters: style ("consistent", "atx", "atxclosed", "setext", "setextwith_atx"; default "consistent")
This rule is triggered when different header styles (atx, setext, and 'closed' atx) are used in the same document:
# ATX style H1
## Closed ATX style H2 ##
Setext style H1
===============
Be consistent with the style of header used in a document:
# ATX style H1
## ATX style H2
The setextwithatx doc style allows atx-style headers of level 3 or more in documents with setext style headers:
Setext style H1
===============
Setext style H2
---------------
### ATX style H3
Note: the configured header style can be a specific style to use (atx, atxclosed, setext, setextwith_atx), or simply require that the usage be consistent within the document.
Unordered list style Open
- `Alt+Left` - Skip backwards
- Read upRead up
- Exclude checks
MD004 - Unordered list style
Tags: bullet, ul
Aliases: ul-style
Parameters: style ("consistent", "asterisk", "plus", "dash"; default "consistent")
This rule is triggered when the symbols used in the document for unordered list items do not match the configured unordered list style:
* Item 1
+ Item 2
- Item 3
To fix this issue, use the configured style for list items throughout the document:
* Item 1
* Item 2
* Item 3
Note: the configured list style can be a specific symbol to use (asterisk, plus, dash), or simply require that the usage be consistent within the document.
Properties should be ordered --barBG, --barBorder, --bgScreen, --buttonColor, --pausedTextColor, --progressColor, --textColor, --textHighlight Open
--progressColor: #222;
- Exclude checks
Avoid using id selectors Open
#__stutter.theme-gameboy {
- Exclude checks
Line should be indented with spaces, not tabs Open
--bgScreen: rgba(0, 0, 0, 0.5);
- Exclude checks
Properties should be ordered --barBG, --barBorder, --bgScreen, --buttonColor, --pausedTextColor, --progressColor, --textColor, --textHighlight Open
--progressColor: #3b4252;
- Exclude checks
Properties should be ordered --barBG, --barBorder, --bgScreen, --buttonColor, --pausedTextColor, --progressColor, --textColor, --textHighlight Open
--progressColor: #073642;
- Exclude checks
Selector __stutter
should be written in lowercase with hyphens Open
#__stutter.theme-terminal {
- Exclude checks
Prefer single quoted strings Open
@import "nord";
- Exclude checks
Properties should be ordered display, font-size, margin, text-align, width Open
width: 200px;
- Exclude checks
Properties should be ordered align-items, background-color, cursor, display, font-family, justify-content, padding Open
display: flex;
- Exclude checks
Inconsistent indentation for list items at the same level Open
2. Press `Alt+R` to trigger Stutter by hotkey.
- Read upRead up
- Exclude checks
MD005 - Inconsistent indentation for list items at the same level
Tags: bullet, ul, indentation
Aliases: list-indent
This rule is triggered when list items are parsed as being at the same level, but don't have the same indentation:
* Item 1
* Nested Item 1
* Nested Item 2
* A misaligned item
Usually this rule will be triggered because of a typo. Correct the indentation for the list to fix it:
* Item 1
* Nested Item 1
* Nested Item 2
* Nested Item 3
Inconsistent indentation for list items at the same level Open
- `Alt+P` - Pause/Resume
- Read upRead up
- Exclude checks
MD005 - Inconsistent indentation for list items at the same level
Tags: bullet, ul, indentation
Aliases: list-indent
This rule is triggered when list items are parsed as being at the same level, but don't have the same indentation:
* Item 1
* Nested Item 1
* Nested Item 2
* A misaligned item
Usually this rule will be triggered because of a typo. Correct the indentation for the list to fix it:
* Item 1
* Nested Item 1
* Nested Item 2
* Nested Item 3
Line length Open
1. Click on the <img src="./icons/stutter.svg" width="16"> icon in the browser to start _Stuttering_. If you have text selected, it will use this as the content to Stutter, otherwise the entire page will be used.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the code_blocks
and/or tables
parameters to false.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
You can leave feedback using [GitHub issues](https://github.com/jamestomasino/stutter/issues). If you would like to discuss problems or features with me directly, you can visit the [#stutter IRC channel on Libera.Chat](https://kiwiirc.com/nextclient/#irc://irc.libera.chat/#stutter).
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the code_blocks
and/or tables
parameters to false.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Emphasis used instead of a header Open
**stutter**
- Read upRead up
- Exclude checks
MD036 - Emphasis used instead of a header
Tags: headers, emphasis
Parameters: punctuation (string; default ".,;:!?")
Aliases: no-emphasis-as-header
This check looks for instances where emphasized (i.e. bold or italic) text is used to separate sections, where a header should be used instead:
**My document**
Lorem ipsum dolor sit amet...
_Another section_
Consectetur adipiscing elit, sed do eiusmod.
To fix this, use markdown headers instead of emphasized text to denote sections:
# My document
Lorem ipsum dolor sit amet...
## Another section
Consectetur adipiscing elit, sed do eiusmod.
Note: this rule looks for single line paragraphs that consist entirely of emphasized text. It won't fire on emphasis used within regular text, multi-line emphasized paragraphs, and paragraphs ending in punctuation. Similarly to rule MD026, you can configure what characters are recognized as punctuation.
Selector __stutter
should be written in lowercase with hyphens Open
#__stutter.theme-hacktoberfest {
- Exclude checks
Line should be indented with spaces, not tabs Open
--bgScreen: rgba(0, 0, 0, 0.5);
- Exclude checks