mdbook-github-authors 0.1.0

mdbook preprocessor to display Github profiles of authors of a page
Documentation 
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

# mdbook-github-authors

----------------------------------------------------------------------------------------

[![Lint](https://github.com/VectorInstitute/mdbook-github-authors/actions/workflows/lint.yml/badge.svg)](https://github.com/VectorInstitute/mdbook-github-authors/actions/workflows/lint.yml)
[![Test Docs](https://github.com/VectorInstitute/mdbook-github-authors/actions/workflows/test_docs.yml/badge.svg)](https://github.com/VectorInstitute/mdbook-github-authors/actions/workflows/test_docs.yml)
[![Test Lib](https://github.com/VectorInstitute/mdbook-github-authors/actions/workflows/test.yml/badge.svg)](https://github.com/VectorInstitute/mdbook-github-authors/actions/workflows/test.yml)
![GitHub License](https://img.shields.io/github/license/VectorInstitute/mdbook-github-authors)
![GitHub Release](https://img.shields.io/github/v/release/VectorInstitute/mdbook-github-authors)
![docs.rs](https://img.shields.io/docsrs/mdbook-github-authors)

A preprocessor for [mdbook](https://rust-lang.github.io/mdBook/) that creates
chapter-level contributor sections featuring authors' GitHub profiles.

## Installation

```bash
cargo install mdbook-github-authors
```

## Usage

1. Add to your `book.toml`:

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

1. Add contributors/authors using these helpers in your markdown:

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

```markdown
# My Chapter

Content here...

{{#authors rust-lang,contributors}}
```

Will render as:

<img width="924" alt="image" src="https://github.com/user-attachments/assets/c0018fc9-eb1e-4901-a780-ca1d31d449de" />