Struct MDBOOK003

pub struct MDBOOK003;

MDBOOK003: Validates SUMMARY.md structure and formatting

This rule checks:

• File must be named SUMMARY.md (case-sensitive)
• Consistent list delimiters (don’t mix - and *)
• Proper nesting hierarchy (no skipped indentation levels)
• Part titles must be h1 headers only
• Prefix chapters cannot be nested
• No prefix chapters after numbered chapters begin
• Valid link syntax for chapters
• Draft chapters use empty parentheses
• Separators contain only dashes (minimum 3)

Trait Implementations

impl Rule for MDBOOK003

fn id(&self) -> &'static str

Unique identifier for the rule (e.g., “MD001”)

fn name(&self) -> &'static str

Human-readable name for the rule (e.g., “heading-increment”)

fn description(&self) -> &'static str

Description of what the rule checks

fn metadata(&self) -> RuleMetadata

Metadata about this rule’s status and properties

fn check_with_ast<'a>( &self, document: &Document, _ast: Option<&'a AstNode<'a>>, ) -> Result<Vec<Violation>>

Check a document for violations of this rule with optional pre-parsed AST

fn check(&self, document: &Document) -> Result<Vec<Violation>>

Check a document for violations of this rule (backward compatibility)

fn can_fix(&self) -> bool

Whether this rule can automatically fix violations

fn fix(&self, _content: &str, _violation: &Violation) -> Option<String>

Attempt to fix a violation (if supported)

fn create_violation( &self, message: String, line: usize, column: usize, severity: Severity, ) -> Violation

Create a violation for this rule