Crate mdbook_utils
source ·Expand description
§mdbook-utils
For installation and usage instructions for the mdbook-utils
command-line
tool, consult the User Guide.
A list of available commands is displayed when entering mdbook-utils
at a
shell prompt.
The following (https://docs.rs/mdbook-utils/) contains the library API doc. Please consult the Public API page as well.
You will want to use the Public API (over the CLI) to:
- Integrate it in your project, for example call it from a
build.rs
build script, - Extend its capabilities,
- …
Modules§
- Operations on Markdown that are not link- or reference-related
- Example Markdown for testing.
Functions§
- Parse Markdown from all .md files in a given source directory and write all raw events to a file for debugging purposes.
- Parse Markdown from all .md files in a given source directory, extract existing reference definitions, identify URLs that are GitHub repos, create badge URLs for these links, and write to a file.
- Given a Cargo.toml path, generate reference definitions from code dependencies and write them to a file.
- Create a sitemap.xml file from the list of Markdown files in a source directory.
- Test function that uses fake Markdown.
- Parse Markdown from all .md files in a given source directory, write all links found therein to a file.
- Parse Markdown from all .md files in a given source directory, write duplicated links found therein to a file.
- Parse Markdown from all .md files in a given source directory, write duplicated links found therein to a file.
- Parse Markdown from all .md files in a given source directory, write all inline links and autolinks (i.e., not written as reference-style links) found therein to a file.
- Parse Markdown from all .md files in a given source directory and write reference definitions found therein to a file.