NtDocutils is a Material Design Lite theme for Docutils.
Project description
.. raw:: html
<p align="center">
<img alt="NtDocutils" width="240" src="docs/images/ntdocutils.png"/>
</p>
.. image:: https://img.shields.io/pypi/v/NtDocutils.svg
:target: https://pypi.python.org/pypi/NtDocutils
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: License
:target: https://github.com/ntrrg/NtDocutils/blob/v0.3.0/LICENSE
__ https://getmdl.io/
**NtDocutils** is a `Material Design Lite`__ theme for Docutils_. See the
`official site <https://blog.nt.web.ve/en/articles/ntdocutils/>`_ for more info.
Features
========
* All the features from Docutils_ for the ``rst2html5.py`` writer.
* Special roles for emojis and keyboard keys.
* Filter content by OS, distributions, categories or any other filters you
want.
* Attachments, print button and more.
* Print friendly and responsiveness.
* Theme customization.
Install
=======
**NtDocutils** requires:
* `Python <https://www.python.org/>`_ 3.4 or above
* Docutils_ 0.14 (autoinstalled)
* `Pygments <http://pygments.org/>`_ 2.2.0 (autoinstalled)
From PyPI
---------
.. code:: sh
pip install NtDocutils==0.3.0
From source
-----------
.. code:: sh
wget -c 'https://github.com/ntrrg/NtDocutils/archive/v0.3.0.tar.gz'
.. code:: sh
tar -xvf NtDocutils-0.3.0.tar.gz
.. code:: sh
cd NtDocutils-0.3.0
.. code:: sh
python3 setup.py
Usage
=====
Basically, you have to do two things:
#. Create a ``.rst`` file:
``example.rst``:
.. code:: rest
:number-lines:
==========
My Article
==========
:Author: Vultur Gryphus
:Contact: info@vultur.org.ve
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur
sint occaecat cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum.
#. Process your file:
.. code:: sh
ntdocutils example.rst example.html
And that's it, you already have some like this:
.. image:: docs/images/example.png
__ https://blog.nt.web.ve/en/articles/ntdocutils/#usage
The official site shows a better explanation in `this section`__.
Command line reference
----------------------
All options from the ``rst2html5.py`` writer are available.
.. code:: text
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:
.. code:: sh
pip uninstall -y NtDocutils docutils Pygments
Contributing
============
See the `contribution guide <CONTRIBUTING.md>`_ for more information.
Acknowledgment
==============
Working on this project I use/used:
* `Debian <https://www.debian.org/>`_
* `XFCE <https://xfce.org/>`_
* `Sublime Text 3 <https://www.sublimetext.com/3>`_
* `Chrome <https://www.google.com/chrome/browser/desktop/index.html>`_
* `Terminator <https://gnometerminator.blogspot.com/p/introduction.html>`_
* `Zsh <http://www.zsh.org/>`_
* `Git <https://git-scm.com/>`_
* `EditorConfig <http://editorconfig.org/>`_
* `Github <https://github.com>`_
* `Inkscape <https://inkscape.org/en/>`_
* `GIMP <https://www.gimp.org/>`_
* `Material Icons <https://material.io/icons/>`_
* `Roboto <https://fonts.google.com/specimen/Roboto>`_
* `RawGit <https://rawgit.com/>`_
**Docutils Team.** *reStructuredText.* http://docutils.sourceforge.net/rst.html
**Mozilla Developer Network.** *JavaScript.* https://developer.mozilla.org/en-US/docs/Web/JavaScript
.. Links
.. _Docutils: http://docutils.sourceforge.net/
<p align="center">
<img alt="NtDocutils" width="240" src="docs/images/ntdocutils.png"/>
</p>
.. image:: https://img.shields.io/pypi/v/NtDocutils.svg
:target: https://pypi.python.org/pypi/NtDocutils
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: License
:target: https://github.com/ntrrg/NtDocutils/blob/v0.3.0/LICENSE
__ https://getmdl.io/
**NtDocutils** is a `Material Design Lite`__ theme for Docutils_. See the
`official site <https://blog.nt.web.ve/en/articles/ntdocutils/>`_ for more info.
Features
========
* All the features from Docutils_ for the ``rst2html5.py`` writer.
* Special roles for emojis and keyboard keys.
* Filter content by OS, distributions, categories or any other filters you
want.
* Attachments, print button and more.
* Print friendly and responsiveness.
* Theme customization.
Install
=======
**NtDocutils** requires:
* `Python <https://www.python.org/>`_ 3.4 or above
* Docutils_ 0.14 (autoinstalled)
* `Pygments <http://pygments.org/>`_ 2.2.0 (autoinstalled)
From PyPI
---------
.. code:: sh
pip install NtDocutils==0.3.0
From source
-----------
.. code:: sh
wget -c 'https://github.com/ntrrg/NtDocutils/archive/v0.3.0.tar.gz'
.. code:: sh
tar -xvf NtDocutils-0.3.0.tar.gz
.. code:: sh
cd NtDocutils-0.3.0
.. code:: sh
python3 setup.py
Usage
=====
Basically, you have to do two things:
#. Create a ``.rst`` file:
``example.rst``:
.. code:: rest
:number-lines:
==========
My Article
==========
:Author: Vultur Gryphus
:Contact: info@vultur.org.ve
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur
sint occaecat cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum.
#. Process your file:
.. code:: sh
ntdocutils example.rst example.html
And that's it, you already have some like this:
.. image:: docs/images/example.png
__ https://blog.nt.web.ve/en/articles/ntdocutils/#usage
The official site shows a better explanation in `this section`__.
Command line reference
----------------------
All options from the ``rst2html5.py`` writer are available.
.. code:: text
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:
.. code:: sh
pip uninstall -y NtDocutils docutils Pygments
Contributing
============
See the `contribution guide <CONTRIBUTING.md>`_ for more information.
Acknowledgment
==============
Working on this project I use/used:
* `Debian <https://www.debian.org/>`_
* `XFCE <https://xfce.org/>`_
* `Sublime Text 3 <https://www.sublimetext.com/3>`_
* `Chrome <https://www.google.com/chrome/browser/desktop/index.html>`_
* `Terminator <https://gnometerminator.blogspot.com/p/introduction.html>`_
* `Zsh <http://www.zsh.org/>`_
* `Git <https://git-scm.com/>`_
* `EditorConfig <http://editorconfig.org/>`_
* `Github <https://github.com>`_
* `Inkscape <https://inkscape.org/en/>`_
* `GIMP <https://www.gimp.org/>`_
* `Material Icons <https://material.io/icons/>`_
* `Roboto <https://fonts.google.com/specimen/Roboto>`_
* `RawGit <https://rawgit.com/>`_
**Docutils Team.** *reStructuredText.* http://docutils.sourceforge.net/rst.html
**Mozilla Developer Network.** *JavaScript.* https://developer.mozilla.org/en-US/docs/Web/JavaScript
.. Links
.. _Docutils: http://docutils.sourceforge.net/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
NtDocutils-0.3.0.tar.gz
(408.5 kB
view hashes)
Built Distribution
NtDocutils-0.3.0-py3-none-any.whl
(417.9 kB
view hashes)
Close
Hashes for NtDocutils-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 821d70c10146418b148b6c5fbf6e6389c7aaf3d6b39a7fe82fd6b3b68a6d05a4 |
|
MD5 | 2591be5347c471a35dee9a63c192500d |
|
BLAKE2b-256 | cabeb315d94e08c6ac045de55d53f74c3a9b2f15e1ff5bf1d411b90e68cc1652 |