NtDocutils is a Material Design Lite theme for Docutils. See the official site for more info.
Features
- All the features from Docutils for the
rst2html5.py
front end. - Special roles for emojis and keyboard keys.
- Filter content by OS, distributions, categories or any other filters you want.
- Attachments, print button, translations and versions linking and more.
- Print friendly and responsiveness.
- Theme customization.
Install
NtDocutils requires:
From PyPI
# pip install NtDocutils==0.3.3
From source
$ wget -c 'https://github.com/ntrrg/NtDocutils/archive/v0.3.3.tar.gz'
$ tar -xvf NtDocutils-0.3.3.tar.gz
$ cd NtDocutils-0.3.3
# python3 setup.py
Usage
Basically, you have to do two things:
-
Create a
.rst
file:example.rst
:1 ========== 2 My Article 3 ========== 4 5 :Author: Vultur Gryphus 6 :Contact: info@vultur.org.ve 7 8 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do 9 eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad 10 minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip 11 ex ea commodo consequat. Duis aute irure dolor in reprehenderit in 12 voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur 13 sint occaecat cupidatat non proident, sunt in culpa qui officia 14 deserunt mollit anim id est laborum.
-
Process your file:
$ ntdocutils example.rst example.html
And that's it, you already have some like this:
The official site shows a better explanation in this section.
Command line reference
All options from the rst2html5.py
front end are available.
ntdocutils [-h] [-V] [-S SERVER] SOURCE DESTINATION
-h, --help | Shows the help message. |
-V, --version | Shows the NtDocutils version. |
-S SERVER, --server SERVER | |
Server from where assets will be downloaded. If local is passed as
value, it will activate the offline mode, this will create a directory
with the theme name in the DESTINATION parent folder and stores the
necessary assets in there. |
Uninstall
Should be enough with this:
# pip uninstall -y NtDocutils docutils Pygments
Contributing
See the contribution guide for more information.
Acknowledgment
Working on this project I use/used:
- Debian
- XFCE
- Sublime Text 3
- Chrome
- Terminator
- Zsh
- Git
- EditorConfig
- Github
- Inkscape
- GIMP
- Material Icons
- Roboto
- RawGit
Docutils Team. reStructuredText. http://docutils.sourceforge.net/rst.html
Mozilla Developer Network. JavaScript. https://developer.mozilla.org/en-US/docs/Web/JavaScript