index.md

This section contains rules for Markdown with support for GitHub Flavored Markdown which is based on the CommonMark specification.

Markdown is a lightweight markup language with plain text formatting syntax for writing structured documents. It is designed so that it can be converted to HTML and many other formats.

As the initial specification of Markdown contained ambiguities and unanswered questions, many implementations and extensions of Markdown in many languages appeared over the years to answer these issues. Some extended the original Markdown syntax with conventions for footnotes, tables, and other document elements and allowed Markdown documents to be rendered in many formats other than HTML.

Today the most used specifications are CommonMark and its superset GitHub Flavored Markdown which powers the content of many large websites like GitHub, StackOverflow, and Reddit used by millions of people. And Markdown started to be used beyond the web, to author books, articles, slide shows, letters, and lecture notes.

Rules

• Overview
• Accessibility A11Y
  • Alternative Text
• Blockquotes
  • Indentation
  • Multi Line
• Code
  • Blocks
  • Syntax Highlighting
  • Escape Newlines In Terminal Commands
  • No Shell Code Dollar Sign
  • Within Lists
  • Inline
  • Marker Character Style
  • Use Cases
• Comments
  • HTML
• Emphasis
  • Italic
  • Bold
  • Strikethrough
  • No Header Replacement
  • No Inner Spacing
• Headings
  • ATX Style
  • Empty Lines Before And After
  • Content Spacing
  • No Content Before
  • No Duplicate
  • Letter Case
  • Length
  • Punctuation After Content
• Horizontal Rules
  • Marker Character Style
  • No Prepended Or Appended Content
  • Empty Lines Before And After
  • Use Cases
• Images
  • Absolute URLs
  • Badges
• Links
  • Prefer Reference Links
  • Inline
  • Definition Placement
  • Empty Line Before
  • Letter Case
  • No ID Inner Spacing
  • No Trailing Or Leading Title Spaces
  • Spacing After Colon
  • Sorting
  • Reference Link Groups
  • Reference Link Group Ordering
  • No Unused
  • No Undefined
  • Autolink Protocol
  • Unique IDs
  • No Empty URL
  • No Reference Like URL
• Lists
  • Unordered Marker
  • Ordered Marker
  • No Content Before
  • Continuous Indentation
  • Empty Lines
  • Empty Lines Before And After
  • Letter Case
  • Punctuation After Items
  • Checkbox Character Style
• Naming Conventions
  • File Extension
  • File Naming
• Paragraphs
  • No Indentation
• Raw HTML
  • Aligned Content
  • Inline Content
  • Collapsed Content
• Strings
  • Quotes
  • Line Length
• Tables
  • Prefer Lists
  • Empty Lines Before And After
  • Content Spacing
  • Header Delimiter Row Spacing
  • Minimum Column Width
  • Alignment
  • No Indentation
• Whitespace
  • Indentation Character
  • Newline
  • Before Blocks
  • After Sentences
  • Maximum Line Length
  • Trailing