Struct MDBOOK025

pub struct MDBOOK025;

Rule that allows multiple H1 headings in SUMMARY.md files

In mdBook projects, SUMMARY.md files legitimately use multiple H1 headings to organize content into parts and sections. This rule overrides the standard MD025 behavior specifically for SUMMARY.md files.

Implementations

impl MDBOOK025

pub fn new() -> Self

Create a new MDBOOK025 rule

Trait Implementations

impl AstRule for MDBOOK025

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 MDBOOK025

fn default() -> Self

Returns the “default value” for a type.