#mdbook #markdown #preprocessor

app mdbook-checklist

An mdBook preprocessor for generating checklists and indexes

1 unstable release

0.1.0 Feb 18, 2019

#13 in #preprocessor

Custom license

9KB
174 lines

mdBook checklist preprocessor

A preprocessor for gathering checks in an mdBook and generating an index.

Usage

First, you need to install the preprocessor:

cargo install mdbook-checklist-preprocessor

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 <name> | <description>}}. 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)

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.

Dependencies

~13MB
~248K SLoC

j\