mdbook-github-authors

A preprocessor for mdbook that creates chapter-level contributor sections featuring authors' GitHub profiles.

Installation

cargo install mdbook-github-authors

Usage

1. Add to your book.toml:

[preprocessor.github-authors]
command = "mdbook-github-authors"

1. 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: