https://github.com/wuxianucw/mdbook-classy

Paragraph css class annotation for mdbook
https://github.com/wuxianucw/mdbook-classy

Last synced: 10 days ago
JSON representation

Paragraph css class annotation for mdbook

• Host: GitHub
• URL: https://github.com/wuxianucw/mdbook-classy
• Owner: wuxianucw
• License: mit
• Created: 2020-06-26T21:31:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T16:20:08.000Z (8 months ago)
• Last Synced: 2024-10-31T02:19:26.576Z (21 days ago)
• Language: Rust
• Size: 45.9 KB
• Stars: 5
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdbook-classy

## What is this?

This is a focused markdown preprocessor for [mdbook](https://crates.io/crates/mdbook) that makes it simple css to add classes to your markdown paragraphs.

It uses kramdown-style class annotation, changing this

```markdown

{:.class-name}

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

```

to this:

```markdown



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



```


## 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:

```bash

cargo install mdbook-classy

```

Then add the following to `book.toml`:

```bash

[preprocessor.classy]

```