Markdown Style Guide
The Forge Wiki supports the Markdown Markup Language (you can also find a "Cheatsheet" here).
Markdown can be written in various different styles, in this document you will find the standard formatting guide for creating Forge Wiki documentation.
Rules
MD001 - Header levels should only increment by one level at a time
Headers should not be skipped, instead incremented one by one.
Wrong:
Correct:
MD002 - First header should be a top level header
The first header of the document should be a top level header (H1).
Wrong:
Correct:
MD003 - Header style
The header style used on documents should be atx
.
Wrong:
Correct:
MD004 - Unordered list style
Lists should be created using asterisks.
Wrong:
Correct:
MD005 - No inconsistent indentation for list items at the same level
Lists should have consistent indentation, usually this rule will be triggered because of a typo.
Wrong:
Correct:
MD006 - Consider starting bulleted lists at the beginning of the line
Bulleted lists should start on the beginning of the line.
Wrong:
Correct:
MD007 - Unordered list indentation
List items should be indented using 4 spaces.
Wrong:
Correct:
MD009 - No trailing spaces
There shouldn't have any trailing spaces after the end of the lines.
To fix this, find the line that is triggered and remove any trailing spaces from the end.
MD010 - No hard tabs
Spaces should be used for indentation instead of hard tabs.
To fix this, replace any hard tab characters with spaces instead.
MD011 - No reversed link syntax
When creating links you should use the []
surrounding the text and ()
surrounding the link.
Wrong:
Correct:
MD012 - No multiple consecutive blank lines
There should not have more than one consecutive blank line on the document.
Wrong:
Correct:
MD018 - Use space after hash on atx style header
There should be a space after the hashes on atx style headers.
Wrong:
Correct:
MD019 - No multiple spaces after hash on atx style header
There shouldn't have more than 1 space after the hash on atx style headers.
Wrong:
Correct:
MD022 - Headers should be surrounded by blank lines
All headers should have a blank line both before and after (except where the header is at the beginning or end of the document)
Wrong:
Correct:
MD023 - Headers must start at the beginning of the line
Wrong:
Correct:
MD025 - No multiple top level headers in the same document
There should only have one top level header (h1
) on a document.
Wrong:
Correct:
MD027 - No multiple spaces after blockquote symbol
Blockquote should not have more than one space after the blockquote symbol ( >
).
Wrong:
Correct:
MD028 - No blank line inside blockquote
There shouldn't have a blank line inside the same blockquote.
Wrong:
Correct:
Alternatively, if they are supposed to be the same quote, then add the blockquote symbol at the beginning of the blank line
MD029 - Ordered list item prefix
Ordered lists should be ordered by a prefix that increases in numerical order.
Wrong:
Correct:
MD030 - Space after list markers
There should be only one space after a list marker.
Wrong:
Correct:
MD031 - Fenced code blocks should be surrounded by blank lines
Fenced code blocks should be surrounded by blank lines.
Wrong:
Code block
Another code block
Correct:
Code block
Another code block
MD032 - Lists should be surrounded by blank lines
Lists should be surrounded by blank lines.
Wrong:
Correct:
MD034 - No bare URLs
There should no bare urls on the document, surround the links with angle brackets (< >
).
Wrong:
Correct:
MD035 - Horizontal rule style
Horizontal rules should be created using three slashes (---
).
Wrong:
Correct:
MD037 - No spaces inside emphasis markers
There shouldn't have spaces inside emphasis markers (bold, italic).
Wrong:
Correct:
MD038 - No spaces inside code span elements
There shouldn't have spaces inside code span elements.
Wrong:
Correct:
MD039 - No spaces inside link text
There shouldn't have spaces inside link texts.
Wrong:
Correct:
MD046 - Code block style
Code blocks should be fenced.
Wrong:
Correct:
Last updated