Struct MDBOOK006

pub struct MDBOOK006 { /* private fields */ }

MDBOOK006: Validate internal cross-reference links between chapters

This rule validates that internal links with anchor fragments point to valid headings in the target files. It focuses specifically on cross-reference validation between chapters, ensuring that [text](file.md#heading) links work correctly.

The rule:

• Only processes internal links with anchor fragments (e.g., file.md#section)
• Resolves target files relative to the current document
• Parses target files to extract heading anchors
• Validates that the anchor fragment exists in the target file
• Supports configurable anchor ID generation strategies
• Caches parsed files to improve performance on large books

Anchor ID Generation:

• Converts heading text to lowercase
• Replaces spaces and non-alphanumeric characters with hyphens
• Removes leading/trailing hyphens and consecutive hyphens
• Handles Unicode characters appropriately

Trait Implementations

impl AstRule for MDBOOK006

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_ast<'a>( &self, document: &Document, ast: &'a AstNode<'a>, ) -> Result<Vec<Violation>>

Check a document using its AST

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

impl Default for MDBOOK006

fn default() -> MDBOOK006

Returns the “default value” for a type.