iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-04-27 15:43:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[rst/de] light extension of export formats docutils offers (#4654)

Browse Source
This commit is contained in:
nbehrnd 2024-05-17 15:36:55 +02:00 committed by GitHub
parent 21c588354c
commit 89857f5e24
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
de-de/rst-de.html.markdown
View File

@ -10,30 +10,27 @@ lang: de-de
---
RST ist ein Dateiformat, das von der Python Community entwickelt wurde,
um Dokumentation zu schreiben (und ist somit Teil von Docutils).
RST-Dateien sind simple Textdateien mit einer leichtgewichtigen Syntax (im Vergleich zu HTML).
RST-Dateien sind simple Textdateien mit einer leichtgewichtigen Syntax (im
Vergleich zu HTML).
## Installation
Um Restructured Text zu verwenden, musst du [Python](http://www.python.org)
installieren und das `docutils` Paket installieren. `docutils` kann mit dem folgenden
Befehl auf der Kommandozeile installiert werden:
installieren und das `docutils` Paket installieren. `docutils` kann mit dem
folgenden Befehl auf der Kommandozeile installiert werden:
```bash
$ easy_install docutils
easy_install docutils
```
Wenn auf deinem System `pip` installiert kannst du es stattdessen auch verwenden:
Ebenso kann die Installation mit `pip`
```bash
$ pip install docutils
pip install docutils
```
initiiert werden.
## Dateisyntax
@ -82,7 +79,8 @@ Japan Tokyo
=========== ========
Komplexere Tabellen (zusammengeführte Spalten und Zeilen) können einfach
erstellt werden, aber ich empfehle dir dafür die komplette Dokumentation zu lesen :)
erstellt werden, aber ich empfehle dir dafür die komplette Dokumentation zu
lesen :)
Es gibt mehrere Möglichkeiten um Links zu machen:
@ -96,16 +94,20 @@ muss man die Zielurl nach dem Text hinzufügen.
.. _GitHub https://github.com/
```
## Wie man es verwendet
RST kommt mit docutils, dort hast du den Befehl `rst2html`, zum Beispiel:
Mit der Installation von [docutils](https://docutils.sourceforge.io/) bietet
sich beispielsweise die Umwandlung zu html (mehrere Standards stehen zur
Auswahl) an:
```bash
$ rst2html myfile.rst output.html
rst2html myfile.rst output.html
```
*Anmerkung : Auf manchen Systemen könnte es rst2html.py sein*
*Anmerkung: Auf manchen Systemen könnte es `rst2html.py` sein.*
Weitere Exporte bieten beispielsweise `rst2latex`, `rst2man`, `rst2odt`,
`rst2pdf` und `rst2xml`.
Es gibt komplexere Anwendungen, die das RST Format verwenden: