Skip to content

Latest commit

 

History

History
56 lines (54 loc) · 7.74 KB

File metadata and controls

56 lines (54 loc) · 7.74 KB
title Rule Directory
summary Complete list of all mdsmith rules with status and description, generated from rule READMEs.

Rule Directory

All mdsmith rules. Each rule links to its full README with parameters, examples, and diagnostics.

Rule Name Status Description
MDS001 line-length ready Line exceeds maximum length.
MDS002 heading-style ready Heading style must be consistent.
MDS003 heading-increment ready Heading levels should increment by one. No jumping from # to ###.
MDS004 first-line-heading ready First line of the file should be a heading.
MDS005 no-duplicate-headings ready No two headings should have the same text.
MDS006 no-trailing-spaces ready No trailing whitespace at the end of lines.
MDS007 no-hard-tabs ready No tab characters. Use spaces instead.
MDS008 no-multiple-blanks ready No more than one consecutive blank line.
MDS009 single-trailing-newline ready File must end with exactly one newline character.
MDS010 fenced-code-style ready Fenced code blocks must use a consistent delimiter.
MDS011 fenced-code-language ready Fenced code blocks must specify a language.
MDS012 no-bare-urls ready URLs must be wrapped in angle brackets or as a link, not left bare.
MDS013 blank-line-around-headings ready Headings must have a blank line before and after.
MDS014 blank-line-around-lists ready Lists must have a blank line before and after.
MDS015 blank-line-around-fenced-code ready Fenced code blocks must have a blank line before and after.
MDS016 list-indent ready List items must use consistent indentation.
MDS017 no-trailing-punctuation-in-heading ready Headings should not end with punctuation.
MDS018 no-emphasis-as-heading ready Don't use bold or emphasis on a standalone line as a heading substitute.
MDS019 catalog ready Catalog content must reflect selected front matter fields from files matching its glob.
MDS020 required-structure ready Document structure and front matter must match its schema.
MDS021 include ready Include section content must match the referenced file.
MDS022 max-file-length ready File must not exceed maximum number of lines.
MDS023 paragraph-readability ready Paragraph readability index must not exceed a threshold.
MDS024 paragraph-structure ready Paragraphs must not exceed sentence and word limits.
MDS025 table-format ready Tables must have consistent column widths and padding.
MDS026 table-readability ready Tables must stay within readability complexity limits.
MDS027 cross-file-reference-integrity ready Links to local files and heading anchors must resolve.
MDS028 token-budget ready File must not exceed a token budget.
MDS029 conciseness-scoring not-ready Paragraph conciseness score must not fall below a threshold.
MDS030 empty-section-body ready Section headings must include meaningful body content.
MDS031 unclosed-code-block ready Fenced code blocks must have a closing fence delimiter.
MDS032 no-empty-alt-text ready Images must have non-empty alt text for accessibility.
MDS033 directory-structure ready Markdown files must exist only in explicitly allowed directories.
MDS036 section-size-limits ready Section length must not exceed per-level or per-heading limits.