-
Notifications
You must be signed in to change notification settings - Fork 170
Improve markdown format in the documentation #5666
Copy link
Copy link
Open
Labels
agentAll the issues related to make the CLI work better with coding agentsAll the issues related to make the CLI work better with coding agentsdocumentationux
Description
remyleone
opened on Jun 9, 2026
Issue body actions
- MD001 - Heading levels should only increment by one level at a time
- MD004 - Inconsistent style for unordered list indicators
- MD005 - Inconsistent indentation for list items at the same level
- MD007 - Unordered list indentation (expected 2 spaces)
- MD009 - Trailing spaces at the end of a line
- MD010 - Hard tabs found in the document (use spaces instead)
- MD012 - Multiple consecutive blank lines
- MD013 - Line length exceeds maximum (typically 80 or 120 characters)
- MD022 - Headings should be surrounded by blank lines
- MD024 - Multiple headings with the same content
- MD025 - Multiple top-level headings (more than one H1)
- MD026 - Trailing punctuation in heading (colon, semicolon, comma)
- MD031 - Fenced code blocks should be surrounded by blank lines
- MD032 - Lists should be surrounded by blank lines
- MD033 - Inline HTML detected (use markdown instead)
- MD034 - Bare URL detected (use angle brackets or link syntax)
- MD040 - Fenced code blocks should have a language specified
- MD041 - First line in file should be a top-level heading
- MD042 - Empty link text detected
- MD046 - Code block style inconsistency (fenced vs indented)
- MD047 - File should end with a single newline character
- MD051 - Link to internal anchor that doesn't exist
- MD056 - Link to heading that doesn't exist
- MD059 - Link to image reference that doesn't exist
- MD062 - Link text missing or empty
- MD064 - First heading in file should be top level (H1)
- MD076 - Code block has no matching closing fence
- MD077 - Reference link label not found
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
agentAll the issues related to make the CLI work better with coding agentsAll the issues related to make the CLI work better with coding agentsdocumentationux
Type
Fields
No fields configured for Feature.