Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Improve documentation

  • Loading branch information
ntrrg committed May 14, 2019
1 parent dc030ac commit 4dbc275eaec2ab409222a7446cc9e77b3a7d25e7
Showing with 9 additions and 9 deletions.
  1. +1 −1 README.md
  2. +4 −4 README.en.md → docs/index.en.md
  3. +4 −4 README.es.md → docs/index.es.md
@@ -4,8 +4,6 @@
It acts as a wrapper for the `rst2html5.py` frontend, and that enables the
customization possibility of the resulting file.

{{< toc >}}

# Install

**Requirements:**
@@ -69,7 +67,8 @@ $ ntdocutils example.rst example.html

And that's it, you already have a HTML file, just like Docutils.

{{< img src="https://ntrrg.github.io/ntdocutils/example.png" alt="Default Theme" class="block" >}}
<img class="block lazy-load" alt="Default Theme"
data-src="https://ntrrg.github.io/ntdocutils/images/example.png"/>

To use a theme, just install it and pass the `-T THEME` flag, for example, to
use the [MDL theme](https://ntrrg.github.io/ntdocutils-theme-mdl):
@@ -84,7 +83,8 @@ $ ntdocutils -T mdl example.rst example.html

And this is the result:

{{< img src="https://ntrrg.github.io/ntdocutils/mdl-example.png" alt="MDL Theme" class="block" >}}
<img class="block lazy-load" alt="MDL Theme"
data-src="https://ntrrg.github.io/ntdocutils/images/mdl-example.png"/>

## CLI

@@ -4,8 +4,6 @@
Su función es ser un mediador para el frontend `rst2html5.py`, y con esto
habilitar la posibilidad de personalizar el archivo obtenido.

{{< toc >}}

# Instalación

**Requisitos:**
@@ -69,7 +67,8 @@ $ ntdocutils example.rst example.html

Y eso es todo, ya debería tener su archivo HTML con el estilo predeterminado.

{{< img src="https://ntrrg.github.io/ntdocutils/example.png" alt="Default Theme" class="block" >}}
<img class="block lazy-load" alt="Tema predeterminado"
data-src="https://ntrrg.github.io/ntdocutils/images/example.png"/>

Para usar un tema, solo debe instalarse y pasarse la opción `-T TEMA`, por
ejemplo, para usar el [tema MDL](https://ntrrg.github.io/ntdocutils-theme-mdl):
@@ -84,7 +83,8 @@ $ ntdocutils -T mdl example.rst example.html

Y el resultado es:

{{< img src="https://ntrrg.github.io/ntdocutils/mdl-example.png" alt="MDL Theme" class="block" >}}
<img class="block lazy-load" alt="Tema MDL"
data-src="https://ntrrg.github.io/ntdocutils/images/mdl-example.png"/>

## CLI

0 comments on commit 4dbc275

Please sign in to comment.
You can’t perform that action at this time.