Lib.rs

mdBook 元数据预处理器

mdBook 预处理器，用于解析 Markdown 元数据。

入门

1. 安装命令行工具

   cargo install mdbook-metadata
   

2. 将预处理器添加到您的 book.toml 文件中

   [preprocessor.metadata]
   valid-tags = ["title", "author", "keywords", "released"]
   default-author = "Jane Doe"
   continue-on-error = true # default: true
   

3. 将元数据添加到您的 Markdown 文件中

   ---
    title: Example
    author: Your Name
    keywords: tag1, tag2
    released: false
    ---
   
    # Example
   

4. 构建您的书籍并在本地提供服务

   mdbook serve --hostname 0.0.0.0
   

5. 验证渲染的 HTML 头标签是否正确（标题和元数据）。

许可协议

版权（C）2024 Jefferson Johannes Roth Filho。有关更多信息，请参阅 LICENSE。

联系方式

Jefferson Roth - [email protected]

项目链接： https://hub.docker.com/r/jeffroth/mdbook-metadata

crates.io: mdbook-metadata