mdbook-github-authors
| Crates.io | mdbook-github-authors |
| lib.rs | mdbook-github-authors |
| version | 0.1.0 |
| created_at | 2025-02-06 04:45:00.22315+00 |
| updated_at | 2025-02-06 18:26:05.634119+00 |
| description | mdbook preprocessor to display Github profiles of authors of a page |
| homepage | |
| repository | https://github.com/VectorInstitute/mdbook-github-authors |
| max_upload_size | |
| id | 1545057 |
| size | 88,677 |
vector-ai-engineering (github:vectorinstitute:vector-ai-engineering)
documentation
README
mdbook-github-authors
A preprocessor for mdbook that creates chapter-level contributor sections featuring authors' GitHub profiles.
Installation
cargo install mdbook-github-authors
Usage
- Add to your
book.toml:
[preprocessor.github-authors]
command = "mdbook-github-authors"
- Add contributors/authors using these helpers in your markdown:
<!-- Single author -->
{{#author username}}
<!-- Multiple authors -->
{{#authors username1,username2,username3}}
[!NOTE] Rather than expanding in-place, this preprocessor adds a stylized Contributor section to the bottom of the Chapter, irrespective of where these author helpers are found in the raw markdown file.
The preprocessor will generate a "Contributors" section at the bottom of each chapter listing the GitHub profiles of specified authors.
Examples
# My Chapter
Content here...
{{#authors rust-lang,contributors}}
Will render as: