mdbook_github_authors/
lib.rs

1//! # `mdbook-github-authors`
2//!
3//! This crate produces a preprocessor for the [rust-lang mdbook](https://github.com/rust-lang/mdBook)
4//! project that lists authors via their Github profiles in a Contributor section
5//! appended to the bottom of a Chapter.
6//!
7//! ## Basic Usage
8//!
9//! First, install the crate:
10//!
11//! ```sh
12//! cargo install mdbook-github-authors
13//! ```
14//!
15//! Next, and as with all preprocessor extensions, to include `mdbook-github-authors`
16//! in your book, add the following to your `book.toml`:
17//!
18//! ```sh
19//! [preprocessor.github-authors]
20//! command = "mdbook-github-authors"
21//! ```
22//!
23//! In order to add an author or list of authors in your chapter, there are two
24//! supported helpers:
25//!
26//! ```markdown
27//! <!-- for single author -->
28//! {{#author <github-username>}}
29//!
30//! <!-- for multiple authors -->
31//! {{#authors <comma-separated-list-of-usernames>>}}
32//! ```
33//!
34//! For more details see the project's [README](https://github.com/VectorInstitute/mdbook-github-authors)
35
36pub mod github_authors;
37
38pub use github_authors::GithubAuthorsPreprocessor;
mdbook_github_authors/lib.rs

mdbook_github_authors/
lib.rs
