Struct MD057Config 

pub struct MD057Config {
    pub absolute_links: AbsoluteLinksOption,
    pub compact_paths: bool,
    pub search_paths: Vec<String>,
    pub roots: Vec<String>,
}

Configuration for MD057 (relative link validation)

This rule validates that relative links point to existing files.

Fields

absolute_links: AbsoluteLinksOption

How to handle absolute links (paths starting with /)

• “ignore” (default): Skip validation for absolute links
• “warn”: Report a warning for absolute links
• “relative_to_docs”: Resolve relative to MkDocs docs_dir and validate
• “relative_to_roots”: Resolve relative to one or more configured root directories

compact_paths: bool

Warn when relative links contain unnecessary path traversal. When enabled, ../sub_dir/file.md from within sub_dir/ warns and suggests the shorter equivalent file.md.

search_paths: Vec<String>

Additional directories to search when a relative link is not found relative to the file’s directory.

Paths are resolved relative to the project root (where .rumdl.toml or pyproject.toml is found), or relative to the current working directory.

For Obsidian users: the attachment folder is auto-detected from .obsidian/app.json when flavor = "obsidian" is set, so this option is typically not needed. Use it for custom setups or non-Obsidian tools.

Example:

[MD057]
search-paths = ["assets", "images", "attachments"]

roots: Vec<String>

Root directories used when absolute-links = "relative_to_roots".

Absolute links are resolved against each root in order; the first root where the target file exists passes the check. A warning is emitted only when none of the roots contain the target.

Paths are resolved relative to the current working directory when not absolute. Trailing slashes are normalized automatically.

When roots is empty and absolute-links = "relative_to_roots", the rule emits a “not validated” warning for every absolute link, consistent with the fallback behavior of relative_to_docs when no mkdocs.yml is found.

Example:

[MD057]
absolute-links = "relative_to_roots"
roots = ["content/en", "content/zh-cn"]

Trait Implementations

impl Clone for MD057Config

fn clone(&self) -> MD057Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MD057Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MD057Config

fn default() -> MD057Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MD057Config

where MD057Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MD057Config

fn eq(&self, other: &MD057Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RuleConfig for MD057Config

const RULE_NAME: &'static str = "MD057"

The rule name (e.g., “MD009”)

impl Serialize for MD057Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MD057Config