mirror of
https://github.com/adambard/learnxinyminutes-docs.git
synced 2025-04-26 15:13:56 +00:00
[rst/*] highlight
This commit is contained in:
parent
39727a7971
commit
8e94abc88b
@ -36,7 +36,7 @@ initiiert werden.
|
|||||||
|
|
||||||
Ein einfaches Beispiel für die Dateisyntax:
|
Ein einfaches Beispiel für die Dateisyntax:
|
||||||
|
|
||||||
```
|
```rst
|
||||||
.. Zeilen, die mit zwei Punkten starten sind spezielle Befehle.
|
.. Zeilen, die mit zwei Punkten starten sind spezielle Befehle.
|
||||||
|
|
||||||
.. Wenn kein Befehl gefunden wird, wird die Zeile als Kommentar gewertet.
|
.. Wenn kein Befehl gefunden wird, wird die Zeile als Kommentar gewertet.
|
||||||
|
@ -9,7 +9,6 @@ filename: restructuredtext-es.rst
|
|||||||
lang: es-es
|
lang: es-es
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
RST, de Restructured Text, es un formato de fichero creado por la comunidad Python para escribir documentación. Es parte del paquete [Docutils](https://docutils.sourceforge.io/rst.html).
|
RST, de Restructured Text, es un formato de fichero creado por la comunidad Python para escribir documentación. Es parte del paquete [Docutils](https://docutils.sourceforge.io/rst.html).
|
||||||
|
|
||||||
RST es un lenguaje de marcas similar a HTML pero mucho más ligero y fácil de leer.
|
RST es un lenguaje de marcas similar a HTML pero mucho más ligero y fácil de leer.
|
||||||
@ -30,12 +29,11 @@ Si tu sistema tiene `pip`, también puedes utilizarlo para instalar `docutils`.
|
|||||||
$ pip install docutils
|
$ pip install docutils
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Sintaxis.
|
## Sintaxis.
|
||||||
|
|
||||||
Un ejemplo simple de sintaxis:
|
Un ejemplo simple de sintaxis:
|
||||||
|
|
||||||
```
|
```rst
|
||||||
.. Las líneas que empiezan por un punto seguido de otro punto son comandos especiales. Si no se encuentra ningún comando, se considerará que esa línea es un comentario.
|
.. Las líneas que empiezan por un punto seguido de otro punto son comandos especiales. Si no se encuentra ningún comando, se considerará que esa línea es un comentario.
|
||||||
|
|
||||||
========================================================================
|
========================================================================
|
||||||
@ -65,14 +63,14 @@ Recuerda alinear los símbolos de lista (como - o \*) al margen izquierdo del an
|
|||||||
- Segundo elemento
|
- Segundo elemento
|
||||||
|
|
||||||
- Subelemento
|
- Subelemento
|
||||||
|
|
||||||
- Tercer elemento
|
- Tercer elemento
|
||||||
|
|
||||||
o
|
o
|
||||||
|
|
||||||
* Primer elemento
|
* Primer elemento
|
||||||
* Segundo elemento
|
* Segundo elemento
|
||||||
|
|
||||||
* Subelemento
|
* Subelemento
|
||||||
|
|
||||||
* Tercer elemento
|
* Tercer elemento
|
||||||
@ -97,7 +95,6 @@ Hay varias formas de construir enlaces:
|
|||||||
.. _GitHub: https://github.com/
|
.. _GitHub: https://github.com/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Como utilizarlo
|
## Como utilizarlo
|
||||||
|
|
||||||
RST viene con el paquete `docutils` dentro del cual está el comando `rst2html`, por ejemplo:
|
RST viene con el paquete `docutils` dentro del cual está el comando `rst2html`, por ejemplo:
|
||||||
@ -114,7 +111,6 @@ Hay aplicaciones más complejas que usan el formato RST:
|
|||||||
- [Sphinx](http://sphinx-doc.org/), un generador de documentación.
|
- [Sphinx](http://sphinx-doc.org/), un generador de documentación.
|
||||||
- y muchos otros.
|
- y muchos otros.
|
||||||
|
|
||||||
|
|
||||||
## Otras lecturas
|
## Otras lecturas
|
||||||
|
|
||||||
- [Referencia rápida oficial](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
- [Referencia rápida oficial](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
||||||
|
@ -15,7 +15,6 @@ dokumentasi (dan menjadi bagian dari Docutils).
|
|||||||
File-file RST adalah sebuah file-file teks simpel dengan sintaks yang ringan
|
File-file RST adalah sebuah file-file teks simpel dengan sintaks yang ringan
|
||||||
(dibandingkan dengan HTML).
|
(dibandingkan dengan HTML).
|
||||||
|
|
||||||
|
|
||||||
## Pemasangan
|
## Pemasangan
|
||||||
|
|
||||||
Untuk menggunakan RST, anda harus memasang [Python](http://www.python.org) dan
|
Untuk menggunakan RST, anda harus memasang [Python](http://www.python.org) dan
|
||||||
@ -33,12 +32,11 @@ Jika sistem anda sudah mempunyai `pip`, anda bisa menggunakannya juga:
|
|||||||
$ pip install docutils
|
$ pip install docutils
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Sintaks file
|
## Sintaks file
|
||||||
|
|
||||||
Sebuah contoh sederhana dari sintaks file:
|
Sebuah contoh sederhana dari sintaks file:
|
||||||
|
|
||||||
```
|
```rst
|
||||||
.. Baris yang dimulai dengan dua titik adalah perintah spesial. Tetapi jika
|
.. Baris yang dimulai dengan dua titik adalah perintah spesial. Tetapi jika
|
||||||
perintah tidak ditemukan, maka baris tersebut akan dianggap sebagai komentar
|
perintah tidak ditemukan, maka baris tersebut akan dianggap sebagai komentar
|
||||||
|
|
||||||
@ -98,7 +96,6 @@ otomatis diubah menjadi sebuah link)
|
|||||||
.. _GitHub https://github.com/
|
.. _GitHub https://github.com/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Bagaimana Cara Menggunakannya
|
## Bagaimana Cara Menggunakannya
|
||||||
|
|
||||||
RST hadir dengan docutils di mana anda mempunyai `rst2html`, sebagai contoh:
|
RST hadir dengan docutils di mana anda mempunyai `rst2html`, sebagai contoh:
|
||||||
@ -115,7 +112,6 @@ Tetapi ada beberapa aplikasi kompleks yang menggunakan format RST:
|
|||||||
- [Sphinx](http://sphinx-doc.org/), Generator dokumnetasi
|
- [Sphinx](http://sphinx-doc.org/), Generator dokumnetasi
|
||||||
- dan masih banyak lainnya
|
- dan masih banyak lainnya
|
||||||
|
|
||||||
|
|
||||||
## Bacaan
|
## Bacaan
|
||||||
|
|
||||||
- [Referensi singkat resmi](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
- [Referensi singkat resmi](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
||||||
|
@ -31,12 +31,11 @@ Oppure, se hai `pip` installato sul tuo sistema:
|
|||||||
$ pip install docutils
|
$ pip install docutils
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Sintassi del file
|
## Sintassi del file
|
||||||
|
|
||||||
Ecco un semplice esempio della sintassi RST:
|
Ecco un semplice esempio della sintassi RST:
|
||||||
|
|
||||||
```
|
```rst
|
||||||
.. Le righe che iniziano con due punti sono comandi speciali. Ma se non è possibile trovare alcun comando, la riga viene considerata come un commento
|
.. Le righe che iniziano con due punti sono comandi speciali. Ma se non è possibile trovare alcun comando, la riga viene considerata come un commento
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
@ -104,7 +103,6 @@ Ma ci sono applicazioni più complesse che utilizzano il formato RST:
|
|||||||
- [Sphinx](http://sphinx-doc.org/), un generatore di documentazione
|
- [Sphinx](http://sphinx-doc.org/), un generatore di documentazione
|
||||||
- e molti altri
|
- e molti altri
|
||||||
|
|
||||||
|
|
||||||
## Letture
|
## Letture
|
||||||
|
|
||||||
- [Riferimento ufficiale rapido](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
- [Riferimento ufficiale rapido](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
||||||
|
@ -32,7 +32,7 @@ $ pip install docutils
|
|||||||
|
|
||||||
A simple example of the file syntax:
|
A simple example of the file syntax:
|
||||||
|
|
||||||
```
|
```rst
|
||||||
.. Lines starting with two dots are special commands. But if no command can be found, the line is considered as a comment.
|
.. Lines starting with two dots are special commands. But if no command can be found, the line is considered as a comment.
|
||||||
|
|
||||||
=========================================================
|
=========================================================
|
||||||
|
Loading…
Reference in New Issue
Block a user