#mdbook #parse-markdown #metadata

app mdbook-metadata

mdBook preprocessor to parse markdown metadata

2 releases

0.1.1 Apr 5, 2024
0.1.0 Apr 4, 2024

#221 in Text processing

MIT license

27KB
539 lines


Logo

mdBook Metadata Preprocessor

mdBook preprocessor to parse markdown metadata.

Table of Contents
  1. Getting Started
  2. License
  3. Contact

Getting Started

  1. Install the cli tool:

    cargo install mdbook-metadata
    
  2. Add the preprocessor to your book.toml file:

    [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:

    ---
     title: Example
     author: Your Name
     keywords: tag1, tag2
     released: false
     ---
    
     # Example
    
  4. Build your book and serve it locally:

    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 - jjrothfilho@gmail.com

Project Link: https://hub.docker.com/r/jeffroth/mdbook-metadata

crates.io: mdbook-metadata

Dependencies

~13–25MB
~363K SLoC