mdbook-metadata
| Crates.io | mdbook-metadata |
| lib.rs | mdbook-metadata |
| version | 0.1.1 |
| created_at | 2024-04-04 22:53:23.610733+00 |
| updated_at | 2024-04-05 22:28:22.826211+00 |
| description | mdBook preprocessor to parse markdown metadata |
| homepage | https://github.com/jeffersonroth/mdbook-metadata |
| repository | https://github.com/jeffersonroth/mdbook-metadata |
| max_upload_size | |
| id | 1196872 |
| size | 67,623 |
Jefferson Johannes Roth Filho (jeffersonroth)
documentation
README
mdBook Metadata Preprocessor
mdBook preprocessor to parse markdown metadata.
Table of Contents
Getting Started
-
Install the cli tool:
cargo install mdbook-metadata -
Add the preprocessor to your
book.tomlfile:[preprocessor.metadata] valid-tags = ["title", "author", "keywords", "released"] default-author = "Jane Doe" continue-on-error = true # default: true -
Add metadata to your markdown file:
--- title: Example author: Your Name keywords: tag1, tag2 released: false --- # Example -
Build your book and serve it locally:
mdbook serve --hostname 0.0.0.0 -
Verify the rendered html head tags are correct (title and meta).
License
Copyright (C) 2024 Jefferson Johannes Roth Filho. See LICENSE for more information.
Contact
Jefferson Roth - jjrothfilho@gmail.com
Project Link: https://hub.docker.com/r/jeffroth/mdbook-metadata
crates.io: mdbook-metadata