mdbook-reference-table

Crates.io	mdbook-reference-table
lib.rs	mdbook-reference-table
version	0.1.0
source	src
created_at	2024-04-01 17:00:54.859452
updated_at	2024-04-01 17:00:54.859452
description	mdBook preprocessor to create reference tables
homepage	https://github.com/jeffersonroth/mdbook-reference-table
repository	https://github.com/jeffersonroth/mdbook-reference-table
max_upload_size
id	1192763
size	55,495

Jefferson Johannes Roth Filho (jeffersonroth)

documentation

README

mdBook Reference Table Preprocessor

mdBook preprocessor to create Reference Tables.

Table of Contents

Getting Started
License
Contact

Getting Started

Install the cli tool:
```
cargo install mdbook-reference-table
```
Note: not yet published to crates.io. In the meantime you can clone this repository.

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

Build your book and serve it.

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

Contact

Jefferson Roth - jjrothfilho@gmail.com

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

Commit count: 11