Showing 7 of 7 total issues
Couldn't parse this here string. Open
<<<<<<< HEAD
- Read upRead up
- Exclude checks
Couldn't parse this ...
This parsing error points to the structure ShellCheck was trying to parse when a parser error occurred. See [[Parser error]] for more information.
Notice
Original content from the ShellCheck https://github.com/koalaman/shellcheck/wiki.
Fix any mentioned problems and try again. Open
<<<<<<< HEAD
- Read upRead up
- Exclude checks
Unexpected ..
Note: There is a [known bug](../issues/1036) in the current version when [directives](../wiki/Directive) appear within then
clauses of if
blocks that causes Shellcheck to report SC1072 on otherwise valid code. Avoid using directives within then
clauses - instead place them at the top of the if
block or another enclosing block. This is fixed on the online version and the next release.
See Parser Error.
Notice
Original content from the ShellCheck https://github.com/koalaman/shellcheck/wiki.
Multiple top level headers in the same document Open
# NO MAINTENANCE MODE
- Read upRead up
- Exclude checks
MD025 - Multiple top level headers in the same document
Tags: headers
Aliases: single-h1
Parameters: level (number; default 1)
This rule is triggered when a top level header is in use (the first line of the file is a h1 header), and more than one h1 header is in use in the document:
# Top level header
# Another top level header
To fix, structure your document so that there is a single h1 header that is the title for the document, and all later headers are h2 or lower level headers:
# Title
## Header
## Another header
Rationale: A top level header is a h1 on the first line of the file, and serves as the title for the document. If this convention is in use, then there can not be more than one title for the document, and the entire document should be contained within this header.
Note: The level
parameter can be used to change the top level (ex: to h2) in
cases where an h1 is added externally.
The mentioned parser error was in this simple command. Open
<<<<<<< HEAD
- Read upRead up
- Exclude checks
The mentioned parser error was in ...
This info warning points to the start of what ShellCheck was parsing when it failed. See [[Parser error]] for example and information.
Notice
Original content from the ShellCheck https://github.com/koalaman/shellcheck/wiki.
Line length Open
While I am still interested in continuing this project, I have decided not to spend much effort into producing new features. Feel free to reach out to me through github Issues if you want to take over this codebase and help improve it.
- 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.
Headers should be surrounded by blank lines Open
# NO MAINTENANCE MODE
- Read upRead up
- 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.
Multiple consecutive blank lines Open
- Read upRead up
- Exclude checks
MD012 - Multiple consecutive blank lines
Tags: whitespace, blank_lines
Aliases: no-multiple-blanks
This rule is triggered when there are multiple consecutive blank lines in the document:
Some text here
Some more text here
To fix this, delete the offending lines:
Some text here
Some more text here
Note: this rule will not be triggered if there are multiple consecutive blank lines inside code blocks.