https://github.com/flying-sheep/rust-rst
a reStructuredText parser and renderer
https://github.com/flying-sheep/rust-rst
Last synced: about 2 months ago
JSON representation
a reStructuredText parser and renderer
- Host: GitHub
- URL: https://github.com/flying-sheep/rust-rst
- Owner: flying-sheep
- License: apache-2.0
- Created: 2014-09-23T16:01:23.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T17:32:35.000Z (3 months ago)
- Last Synced: 2025-04-16T23:29:35.912Z (3 months ago)
- Language: Rust
- Homepage: https://crates.io/crates/rst
- Size: 326 KB
- Stars: 103
- Watchers: 9
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.rst
- License: LICENSE-APACHE
Awesome Lists containing this project
README
================
RuSTructuredText
================
.. image:: rust-rst.svg
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:
.. code-block:: bash
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.
.. _Docutils Document Tree: https://docutils.sourceforge.net/docs/ref/doctree.html
.. _reStructuredText specification: https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
.. 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_
.. _comrak: https://github.com/kivikakk/comrak
.. _peg-rst: https://github.com/hhatto/peg-rst