Available on crate feature
doc-audit only.Expand description
Documentation parser for extracting and analyzing markdown content.
This module provides functionality to parse markdown documentation files and extract relevant information for validation including code blocks, API references, version references, and internal links.
Structs§
- ApiReference
- Represents an API reference found in documentation.
- Code
Example - Represents a code example extracted from documentation.
- Documentation
Parser - Parser for documentation files that extracts validation-relevant content.
- Feature
Mention - Represents a feature flag mention in documentation.
- Internal
Link - Represents an internal link to another documentation file.
- Parsed
Document - Represents a parsed documentation file with extracted content.
- Version
Reference - Represents a version reference found in documentation.
Enums§
- ApiItem
Type - Types of API items that can be referenced in documentation.
- Version
Type - Types of version references that can appear in documentation.