Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention the mdBook plugin in the README.md. #72

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@ Jotdown supports Rust edition 2021, i.e. Rust 1.56 and above.
## Usage

Jotdown is primarily a parsing library but also has a minimal CLI
implementation and a simple web demo version.
implementation, a simple web demo, and a [mdBook] [plugin].

[mdBook]: https://github.com/rust-lang/mdBook
[plugin]: https://github.com/dcampbell24/mdbook-djot

### Library

Expand Down Expand Up @@ -86,6 +89,12 @@ WebAssembly backend.

[wasm-pack]: https://rustwasm.github.io/wasm-pack/

### mdBook Plugin

Check out the [test_book] for an example of how this works.

[test_book]: https://github.com/dcampbell24/mdbook-djot/tree/main/test_book

## Status

### Correctness
Expand Down
Loading