Struct MDBOOK005

pub struct MDBOOK005 { /* private fields */ }

MDBOOK005: Detect orphaned markdown files not referenced in SUMMARY.md

This rule checks for markdown files in the project that are not referenced in SUMMARY.md. Such files are “orphaned” and won’t be included in the generated book, which may indicate:

• Incomplete documentation structure
• Forgotten content that should be added to the book
• Old files that should be removed

The rule:

• Only runs on SUMMARY.md files
• Parses all chapter references in SUMMARY.md
• Scans for .md and .markdown files in the project directory
• Reports files that exist but aren’t referenced
• Ignores common files like README.md by default
• Supports configuration for custom ignore patterns

Implementations

impl MDBOOK005

pub fn with_ignored_files(additional_ignored: Vec<String>) -> Self

Create a new instance with custom ignored files (in addition to defaults)

pub fn ignore_file(&mut self, filename: &str)

Add a file to the ignore list

Trait Implementations

impl Default for MDBOOK005

fn default() -> Self

Returns the “default value” for a type.

impl Rule for MDBOOK005

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