Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 809 Bytes

README.md

File metadata and controls

41 lines (26 loc) · 809 Bytes

mdbook-classy

What is this?

This is a focused markdown preprocessor for mdbook that makes it simple css to add classes to your markdown paragraphs.

It uses kramdown-style class annotation, changing this

{:.class-name}
This is a *grand* textual paragraph. Truly **grand**!

to this:

<div class="class-name">

This is a *grand* textual paragraph. Truly **grand**!

</div>

Motifivation

mdbook-classy lets you easily define new stylistic element types for your book.
Give them a class name and define the style for the element in css and you're on your way!

Installation

To install mdbook-classy, use cargo:

cargo install mdbook-classy

Then add the following to book.toml:

[preprocessor.classy]