Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ANSSI-FR/mdbook-checklist
mdbook preprocessor for generating checklists and indexes
https://github.com/ANSSI-FR/mdbook-checklist
Last synced: 3 months ago
JSON representation
mdbook preprocessor for generating checklists and indexes
- Host: GitHub
- URL: https://github.com/ANSSI-FR/mdbook-checklist
- Owner: ANSSI-FR
- License: other
- Created: 2019-02-15T08:40:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-29T09:31:16.000Z (almost 2 years ago)
- Last Synced: 2024-07-18T11:17:07.078Z (4 months ago)
- Language: Rust
- Size: 66.4 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - ANSSI-FR/mdbook-checklist - mdbook preprocessor for generating checklists and indexes (others)
README
# mdBook checklist preprocessor
[![Crates.io](https://img.shields.io/crates/v/mdbook-checklist.svg)](https://crates.io/crates/mdbook-checklist)
[![Github CI](https://github.com/ANSSI-FR/mdbook-checklist/workflows/Rust/badge.svg)](https://github.com/ANSSI-FR/mdbook-checklist/actions)
[![Github CI](https://github.com/ANSSI-FR/mdbook-checklist/workflows/Clippy/badge.svg)](https://github.com/ANSSI-FR/mdbook-checklist/actions)A preprocessor for gathering checks in an mdBook and generating an index.
## Usage
First, you need to install the preprocessor:
```
cargo install mdbook-checklist
```Next, you need to add the preprocessor to your `book.toml`:
```
[book]
authors = ["Me"]
multilingual = false
src = "src"
title = "The Book"[preprocessor.checklist]
```Finally, you can insert marks in your book chapters, according to the following
format: `{{#check | }}`. For example```
# Chapter 1{{#check Note-1 | This is an important note}}
```The mark will be replaced by the name solely (with an anchor to be linked from
the index). Also, for this example, the following index will be generated:> # Checklist
>
> - Chapter 1:
> - [ ] This is an important note ([Note-1](README.md#Note-1))## Options
The title `Checklist` of the generated index can be changed:
```
[preprocessor.checklist]
title = "A list of notes"
```## Licence
This library is published under the [Open Licence 2.0](LICENCE.md).