#mdbook #table #reference #content #create

app mdbook-reference-table

mdBook preprocessor to create reference tables

1 unstable release

0.1.0 Apr 1, 2024

#802 in Text processing

MIT license

20KB
231 lines


Logo

mdBook Reference Table Preprocessor

mdBook preprocessor to create Reference Tables.

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

Getting Started

  1. Install the cli tool:

    cargo install mdbook-reference-table
    

    Note: not yet published to crates.io. In the meantime you can clone this repository.

  2. Add the preprocessor to your book.toml file:

    [preprocessor.reference-table]
     command = "../../target/release/mdbook-reference-table.exe" # If Windows
     reference-table = "./reference-table.yaml" # Relative to your book.toml
    
  3. Build your book and serve it.

  4. Consult and edit your reference table file reference-table.yaml. Example:

    reference-table:
     - id: "audita-quot"
       path: "content/subject-1/audita-quot.md"
     - id: "bos-quae-inde-limen"
       path: "content/subject-2/subfolder-1/bos-quae-inde-limen.md"
     - id: "esse-corpora-achaidas-sacros-ad-quas"
       path: "content/subject-3/subfolder-1/subsubfolder-1/esse-corpora-achaidas-sacros-ad-quas.md"
    

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-reference-table

Dependencies

~13–24MB
~356K SLoC