mdbook-reference-table 0.1.0

mdBook preprocessor to create reference tables
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/jeffersonroth/mdbook-environment">
    <img src="https://raw.githubusercontent.com/jeffersonroth/common-assets/main/assets/images/logo.svg" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">mdBook Reference Table Preprocessor</h3>

  <p align="center">
    mdBook preprocessor to create Reference Tables.
  </p>
</p>

<!-- TABLE OF CONTENTS -->
<details open="open">
  <summary>Table of Contents</summary>
  <ol>
    <li><a href="#getting-started">Getting Started</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>

<!-- GETTING STARTED -->

## Getting Started

1. Install the cli tool:

   ```sh
   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:

   ```toml
   [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:
   
   ```yaml
   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 -->

## License

Copyright (C) 2024 Jefferson Johannes Roth Filho. See `LICENSE` for more information.

<!-- CONTACT -->

## Contact

Jefferson Roth - <jjrothfilho@gmail.com>

Project Link: [https://hub.docker.com/r/jeffroth/mdbook-reference-table](https://hub.docker.com/r/jeffroth/mdbook-reference-table)