WYSIWYG reStructuredText-Editor

Ich möchte ReadTheDocs verwenden, das Sphinx verwendet , das wiederum restructuredtext verwendet .

Die reST-Editoren, die ich bisher gefunden habe, sind wie die Textverarbeitungen der 80er Jahre, bei denen Sie den Text bearbeitet haben, um Tags (z. B. "fett an", "fett aus" usw.) an der gewünschten Stelle im Text zu platzieren, dann konnten Sie sehen das Endergebnis in einem anderen Rahmen. Was ich suche, ist ein Post-90er-Wysiwyg-Editor wie Word, bei dem Sie den Bildschirm so aussehen lassen, wie Sie es möchten, und der markierte Text während der Arbeit generiert wird.

Für manche von Ihnen ist das Arbeiten im Text am angenehmsten. Das will ich Ihnen nicht nehmen, machen Sie mir die Bearbeitung von reST einfach so bequem wie für Sie.

Für welches Betriebssystem?
Willkommen bei den Softwareempfehlungen! Welche Features werden benötigt (zB Bildunterstützung)? Soll der generierte Text nur lokal gespeichert werden oder muss er mit etwas anderem (z. B. einem Webdienst) integriert werden? Irgendeine Preisgrenze? Sehen Sie sich bitte Was ist erforderlich, damit eine Frage „genügend Informationen“ enthält? Bearbeiten Sie dann Ihre Frage und füllen Sie die Lücken aus. Das erhöht deine Chancen auf gute und passende Antworten dramatisch ;)
Die Betriebssysteme, die ich verwende, sind Windows und Android, aber eine Online-Version würde auch funktionieren, vorausgesetzt, ich kann den resultierenden Text herunterladen. Wie ich im ursprünglichen Beitrag sagte, beabsichtige ich, den Text für die Dokumentation mit Sphinx und ReadTheDocs zu verwenden, also muss er auf meinen PC übertragbar sein. Am effizientesten wäre natürlich eine Windows-Version, die den resultierenden Text lokal sortiert. Bildunterstützung ist wünschenswert.
Ach ja, zum Preis: Je niedriger der Preis, desto besser. Kostenlos ist am besten.
Ich glaube nicht, dass es so etwas gibt. Vor allem, weil der "Markt" zu klein ist. Es ist viel einfacher, einen Editor mit zwei Fenstern zu erstellen, mit der reST-Quelle auf der einen Seite und der gerenderten Vorschau auf der anderen Seite, und die meisten Programmierer und Autoren scheinen damit zufrieden zu sein, also gibt es nicht viel Grund, die Art von Editor zu erstellen, die Sie wollen . Ich denke, am besten verwenden Sie einfach Word und wenden am Ende einen eigenständigen Dokumentkonverter wie Pandoc an.
Eine der wichtigen Anforderungen für RST oder MD oder eines dieser einfachen alten Dateiformate ist, dass die Datei lesbar sein muss, ohne dass sie in PDF oder HTML oder was auch immer gerendert wird. Ein WYSIWYG-Editor, der unlesbare RST ausgibt, ist nicht sinnvoll. Es ist nicht "diff"-fähig für die Versionskontrolle oder den Dokumentationsverlauf. Achte darauf, was du dir wünschst.

Antworten (9)

(Sie haben noch nicht beschrieben, auf welcher Plattform Sie dies ausführen möchten. Ich gehe davon aus, dass Sie eine Web-App wünschen.)

Das 'rsted'-Projekt implementiert einen Texteditor, der reStructuredText erzeugt.

Es ist im Flask-Webframework (Python, JavaScript) implementiert. Der Quellcode ist freie Software für alle Empfänger .

Auf einer Demonstrationsseite unter http://rst.ninjs.org/ können Sie es ausprobieren.

Leider ist das 'rsted'-Projekt kein WYSIWYG-Editor. Es ist ein einfacher Texteditor, der Schaltflächen vorschlägt, um zunächst automatisch eine Struktur mit Tags hinzuzufügen, und das Ergebnis auf der rechten Seite anzeigt. Es ist nicht so schlimm und sogar das Beste, was ich finden konnte, aber weit entfernt von einem WYSIWYG-Editor.

Es ist über zwei Jahre her, seit ich diese Frage gestellt habe, aber ich habe jetzt etwas gefunden, das ich gesucht habe. Es heißt Typora . Es ist ein WYSIWYG-Editor für Markdown (zumindest noch nicht reST).

Es ist nicht sehr hilfreich, einen umstrukturierten Texteditor zu empfehlen, der umstrukturierten Text nicht unterstützt.

Eine andere Lösung, die mir empfohlen wurde, ist Visual Studio Code mit einer reStructuredText-Erweiterung von LeXtudio. Es hat eine Side-by-by-Vorschau und scheint bisher gut zu funktionieren.

Die Frage fordert ausdrücklich, dass das Bearbeiten und Rendern im selben Bereich erfolgt, nicht in zwei separaten.

Ich fand dieses Skript funktioniert sehr gut für mich. Live-Vorschau, funktioniert für jede Umgebung, aber Sie müssen die Schritte zur Einrichtung befolgen.

https://github.com/tonyriverms/sphinx_live_preview

Ehrlich gesagt kann ich verstehen, warum manche Leute ein Frontend haben möchten, besonders wenn sie proprietäre Software wie Windows verwenden ... Kann die Befehlszeile nicht wirklich rocken. Ich benutze Sphinx sehr gerne und das schon seit vielen Jahren. Während einige Leute es als Lernkurve empfinden und vielleicht eine GUI wollen, denke ich, dass die Zeit besser darauf verwendet wird, Funktionen zu verbessern und auf der Software aufzubauen, anstatt ein Gesicht darauf zu werfen. Das ist nur meine Meinung, weil ich die Art und Weise mag, wie sich Sphinx, Jekyll und mkdocs entwickeln.

Wie J. Mani feststellte, ist Lyx ein sehr netter WYSIWM-Editor. In Bezug darauf, ob es die Frage beantwortet, gibt es ein ernstes Problem. Aus meiner Erfahrung mit Lyx und seinen Eingaben können Sie möglicherweise ResT/Sphinx-Dateien herausholen, aber können Sie sie zurückkonvertieren? Lyx hat Eingabeoptionen für sein eigenes natives Lyx-Format sowie Latex und einige andere. Diese funktionieren jedoch nur in einer Teilmenge der Zielsprache. Ich habe versucht, Lyx-Dateien aus Sphinx zu erstellen, indem ich Latex als Zwischensprache verwendete, und es war ein kompletter Fehlschlag. Ihre Erfahrung und Ihr Kilometerstand können variieren, wie es oft der Fall ist.

rstpad scheint gut zu funktionieren, obwohl es seit ein paar Jahren nicht mehr aktualisiert wurde.

Es ist für Windows und Mac verfügbar (und wahrscheinlich Linux, wenn Sie es selbst kompilieren).

Unter macOS habe ich Marked 2 zum Laufen gebracht . Ich hatte Sphinx bereits auf meinem MacBook installiert. In Marked habe ich den 'Prozessor' in geändert _pathto_/rst2html.py. Es funktioniert bisher super! Bearbeiten Sie in Ihrem bevorzugten Texteditor mit Live-Vorschau in Marked.

Ich habe ein Shell-Skript für Marked 2 geschrieben. Wenn dies Ihr processorist, werden RST-Dateien entweder mit rst2html.pyden Standardeinstellungen von Marked gerendert oder auf diese zurückgegriffen. Dadurch kann Marked sowohl RST- als auch MD-Dateien rendern, ohne Ihre Einstellungen zu ändern processor.
#!/bin/bash RST2HTML="__pathto__/rst2html.py" if [ $MARKED_EXT = "rst" ]; dann $RST2HTML /dev/stdin sonst echo "NOCUSTOM" fi

sphinx-gui ist eine Desktop-GUI zum Anzeigen und Bearbeiten von Sphinx-Dokumenten in ReStructuredText. Es wurde mit PySide erstellt. Es ist Open Source und hier verfügbar: https://github.com/audreyr/sphinx-gui

Willkommen Paulus! Bitte erweitern Sie Ihre Antwort. Vielen Dank!

Wie @JohnY kommentierte, ist Pandoc hier wirklich von großem Nutzen. Es kann Dokumente ohne große Probleme von einem Format in ein anderes konvertieren. Sie können also mit Ihrem bevorzugten Editor ein Dokument in Ihrem bevorzugten Format erstellen und es dann mit Pandoc in ReStructuredText oder Markdown konvertieren.

Meistens verwenden Sie das HTML-Format für Quelldokumente, da es sehr beliebt ist. Ich verwende Lyx (falls Sie es nicht wissen, es wird zum Schreiben von LaTex-Dokumenten verwendet, ohne LaTex lernen zu müssen), um Quelldokumente im LaTex-Format zu erstellen. Die Wahl des Eingabeformats kann variieren, aber was zählt, ist, dass Pandoc Ihnen helfen kann.

WYSIWYG reStructuredText-Editor
AntwortenHierDatenschutz-Bestimmungen1y, 0v