Skip to content

a reStructuredText parser and renderer

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

flying-sheep/rust-rst

Repository files navigation

RuSTructuredText

Designed around the Docutils Document Tree and the reStructuredText specification, this is supposed to become a library able to convert reStructuredText and Docutils XML to both each other and HTML5.

Currently it can convert a subset of rST (e.g. this README) to HTML5:

cargo install rst
rst README.rst
# or
cargo run -- README.rst

The contained packages are:

document_tree
├── renderer
│   └──────┐
└── parser │
    └──────┴── rst

This project is dual-licensed under Apache 2.0 and MIT.

Note

If you are looking for the requirements tracking tool rst (Requirements, Specifications and Tests), have a look at the rst_app package instead.

Inspiration

The design was inspired by the comrak Markdown parser library. The rST grammar was inspired by peg-rst