Skip to content

Commit

Permalink
[rst/de] light extension of export formats docutils offers (adambard#…
Browse files Browse the repository at this point in the history
  • Loading branch information
nbehrnd authored May 17, 2024
1 parent 21c5883 commit 89857f5
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions de-de/rst-de.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.)
Expand All @@ -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
Expand Down

0 comments on commit 89857f5

Please sign in to comment.