summaryrefslogtreecommitdiffhomepage
path: root/de-de
diff options
context:
space:
mode:
authornbehrnd <nbehrnd@users.noreply.github.com>2024-05-17 15:36:55 +0200
committerGitHub <noreply@github.com>2024-05-17 07:36:55 -0600
commit89857f5e24eda256f978dc44df04ffa729f69273 (patch)
tree8559f0672ecf271243eb5b409de41517f08f2b28 /de-de
parent21c588354c88b309408b81e738efc6829c9b9c5b (diff)
[rst/de] light extension of export formats docutils offers (#4654)
Diffstat (limited to 'de-de')
-rw-r--r--de-de/rst-de.html.markdown50
1 files changed, 26 insertions, 24 deletions
diff --git a/de-de/rst-de.html.markdown b/de-de/rst-de.html.markdown
index 2c5e63a7..40c5791f 100644
--- a/de-de/rst-de.html.markdown
+++ b/de-de/rst-de.html.markdown
@@ -10,39 +10,36 @@ 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).
-
+um Dokumentation zu schreiben (und ist somit Teil von Docutils).
+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
Ein einfaches Beispiel für die Dateisyntax:
```
-.. 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.
============================================================================
Haupttitel werden mit Gleichheitszeichen darüber und darunter gekennzeichnet
@@ -75,19 +72,20 @@ oder
Tabellen sind einfach zu schreiben:
=========== ==========
-Land Hauptstadt
+Land Hauptstadt
=========== ==========
Frankreich Paris
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 :)
+Komplexere Tabellen (zusammengeführte Spalten und Zeilen) können einfach
+erstellt werden, aber ich empfehle dir dafür die komplette Dokumentation zu
+lesen :)
Es gibt mehrere Möglichkeiten um Links zu machen:
-- Wenn man einen Unterstrich hinter einem Wort hinzufügt: GitHub_ Zusätzlich
-muss man die Zielurl nach dem Text hinzufügen.
+- Wenn man einen Unterstrich hinter einem Wort hinzufügt: GitHub_ Zusätzlich
+muss man die Zielurl nach dem Text hinzufügen.
(Dies hat den Vorteil, dass man keine unnötigen Urls in lesbaren Text einfügt.
- Wenn man die vollständige Url eingibt: https://github.com/
(Dies wird automatisch in ein Link konvertiert.)
@@ -96,18 +94,22 @@ 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:
+Es gibt komplexere Anwendungen, die das RST Format verwenden:
- [Pelican](http://blog.getpelican.com/), ein statischer Webseitengenerator
- [Sphinx](http://sphinx-doc.org/), ein Dokumentationsgenerator