Expand description
§MarkdownDown
A Rust library for acquiring markdown from URLs with smart handling.
This library provides a unified interface for extracting and converting content from various URL sources (HTML pages, Google Docs, Office 365, GitHub) into clean markdown format.
§Architecture
The library follows a modular architecture:
- Core types and traits for extensible URL handling
- HTTP client wrapper for consistent network operations
- URL type detection for automatic handler selection
- Specific handlers for each supported URL type
- Unified public API for simple integration
Re-exports§
pub use config::Config;pub use converters::Converter;pub use converters::HtmlConverter;pub use types::Frontmatter;pub use types::Url;
Modules§
- client
- HTTP client wrapper for network operations HTTP client wrapper for network operations.
- config
- Configuration system Configuration system for the markdowndown library.
- converters
- Content converters for different formats Content converters for transforming various formats to markdown.
- detection
- URL type detection and classification URL type detection and classification module.
- frontmatter
- YAML frontmatter generation and manipulation utilities YAML frontmatter generation and manipulation utilities.
- types
- Core types, traits, and error definitions Core types and data structures for the markdowndown library.
- utils
- Utility functions shared across the codebase Utility functions shared across the codebase.
Structs§
- Markdown
Down - Main library struct providing unified URL to markdown conversion.
Constants§
- VERSION
- Library version information
Functions§
- convert_
url - Convenience function for converting a URL to markdown with default configuration.
- convert_
url_ with_ config - Convenience function for converting a URL to markdown with custom configuration.
- detect_
url_ type - Utility function to detect the type of a URL without converting it.