mdBook Metadata Preprocessor
mdBook preprocessor to parse markdown metadata.
Table of Contents
- Getting Started
- License
- Contact
## Getting Started
1. Install the cli tool:
```sh
cargo install mdbook-metadata
```
2. Add the preprocessor to your `book.toml` file:
```toml
[preprocessor.metadata]
valid-tags = ["title", "author", "keywords", "released"]
default-author = "Jane Doe"
continue-on-error = true # default: true
```
3. Add metadata to your markdown file:
```markdown
---
title: Example
author: Your Name
keywords: tag1, tag2
released: false
---
# Example
```
4. Build your book and serve it locally:
```sh
mdbook serve --hostname 0.0.0.0
```
5. 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 -
Project Link: [https://hub.docker.com/r/jeffroth/mdbook-metadata](https://hub.docker.com/r/jeffroth/mdbook-metadata)
crates.io: [mdbook-metadata](https://crates.io/crates/mdbook-metadata)