mdbook-utils
| Crates.io | mdbook-utils |
| lib.rs | mdbook-utils |
| version | 0.1.3 |
| source | src |
| created_at | 2024-02-04 07:19:35.086905 |
| updated_at | 2024-02-21 00:20:14.240996 |
| description | Tools to manage links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories. |
| homepage | https://john-cd.com/mdbook-utils/ |
| repository | https://github.com/john-cd/mdbook-utils/ |
| max_upload_size | |
| id | 1126144 |
| size | 172,391 |
S John CD (john-cd)
documentation
README
mdBook Utilities
This is a Work In Progress. The command-line interface (CLI) and underlying API are subject to change. A summary of recently released changes is found in RELEASES.md. You may also consult TODO.md.
What is mdbook-utils? What is it used for?
The mdbook-utils command-line tool manages links, reference definitions, and code blocks in large collections of Markdown files, especially mdbook source directories. It is the companion tool for the Rust How-to book (github).
mdbook-utils is useful for the following:
- centralize all reference definitions in one file to make Markdown files more readable and ease link maintenance,
- replace simple Markdown links by badges,
- identify duplicate or broken links,
- generate a sitemap file for your book or website,
- extract fenced code bocks embedded into the Markdown to separate files for easier formatting, debugging and testing,
- replace code examples by mdBook
#includestatements, - conversely replace mdBook includes by the file contents.
Installation and Usage
Consult the User Guide for installation and usage instructions.
Public API
mdbook-utils' underlying library also exposes a public API that may be used from your code.
Key Links
mdbook-utils (github) (docs.rs) (crates.io) (user guide)