blob: 34091904f795b8d96d2009a5f25df2a531e9dc30 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
=========================
RuSTructuredText |travis|
=========================
.. |travis| image:: https://travis-ci.com/flying-sheep/rust-rst.svg?branch=master
:target: https://travis-ci.com/flying-sheep/rust-rst
.. 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: http://docutils.sourceforge.net/docs/ref/doctree.html
.. _reStructuredText specification: http://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
|
