adoc Studio
snipbook
adoc Studio
adoc Studio ist ein Texteditor, mit dem Sie Textdokumente schreiben und gestalten können, z.B.:
-
Anleitungen
-
wissenschaftliche Arbeiten
-
Protokolle
-
Briefe
Alle Dokumente können als HTML oder PDF ausgegeben werden.
Vorteile
✅ adoc Studio benutzt Asciidoc als Markup-Sprache.
✅ ASCIIDoc ist Text mit wenigen klaren Steuerzeichen.
Sie schreiben Fließtext und formatieren mit wenigen Zeichen (=, *, -, etc.). Trotzdem gibt es sehr viele fertige Formate für Hinweise, Warnhinweise, Codeblöcke usw.
✅ Die adoc-Datei enthält nur Fließtext und lesbare Steuerzeichen und ist auch in diesem Format leicht lesbar.
-
Klar lesbar – auch als reiner Text
Anders als HTML oder XML ist AsciiDoc leicht zu lesen und zu schreiben. (Keine spitzen Klammern, sondern einfache Zeichen (=, *, -, etc.).
Perfekt für Entwickler, Redakteure und Techniker.)
✅ Klare Trennung von Inhalt und Layout.
-
Fließtext
-
Layout per css
-
Automatisch generierte Inhaltsverzeichnisse, Listen, Tabellen, Verweise – alles per Syntax.
-
Kein „herumformatieren“ wie in Word oder Markdown-Wildwuchs.
✅ Export auf Knopfdruck
HTML und PDF können exportiert werden.
✅ Ideal für Software-Anleitungen
-
Unterstützt Codeblöcke mit Syntax-Highlighting.
-
Inklusive Querverweise, Include-Dateien, Versionierung, Snippets.
-
Nutzt Metadaten, Attribute und Variablen – effizient bei Updates.
✅ Modular und wiederverwendbar
-
Benutze Sammeldokumente und gliedere in kleine .adoc-Dateien.
-
Binde Module per include::…[] ein.
-
Nutze Attribute und bedingte Einfügungen
-
Besonders nützlich bei Teams und Projekten mit vielen Komponenten.
✅ Sehr gut versionierbar mit GIT
-
Klartext-Dateien → optimal für git diff, Pull Requests, Merge Tracking.
-
Keine binären Dateien wie Word oder PDF – sauberer Workflow.
✅ Erweiterbar & automatisierbar
✅ Zukunftssicher und offen
-
Offen dokumentiertes Format (kein Vendor-Lock-in).
-
Beliebt in der Open-Source-Welt (Red Hat, GitLab, Gradle …).
-
Wächst kontinuierlich und hat eine aktive Community.
jetzt ausprobieren
Sie können eine Testversion herunterladen
und 14 Tage kostenlos testen
die Testversion endet automatisch ohne weitere Kosten.
|
Sie können jede Seite dieses Snipbooks sofort ausprobieren ! |
Dateimanager
Auf der linken Seite sehen Sie den Dateimanager.
-
Der Dateimanager zeigt alle Dateien, die im Projektverzeichnis liegen.
-
.adoc: das ist die Datei in der Sie schreiben
-
Medien ist ein Ordner mit Bildern usw.
-
ggf. weitere Ordner mit Dateien, die zum Projekt gehören.
-
Mit + können Sie weitere Dokumente einfügen
Markieren Sie die Datei in der Sie schreiben.
Dokument.adoc
Das ist die Textdatei, in der Sie arbeiten.
das ist die Textdatei die Sie später als HTML oder PDF exportieren
Dateimanager = Finder
Sie können Dateien direkt hier in den Dateimanager ziehen * aus dem Finder, * aus einem anderen Programm * und auch aus einer Browseransicht!
Finder und Dateimanager zeigen immer die gleichen Dateien und die gleiche Ordnung, egal wo sie arbeiten.
Schreiben
Im Editor können Sie schreiben, im rechten Fenster sehen Sie die Vorschau auf genau der gleichen Höhe
Sie können im Editor ganz einfach schreiben und formatieren:
-
einfach Fließtext schreiben und formatieren
-
Absätze schreiben mit zwei Zeilenschaltungen
-
Überschriften mit = und ein Leerzeichen beginnen
-
Punktaufzählungen mit * und ein Leerzeichen beginnen
Strukturieren mit Überschriften
Schreiben Sie ein oder mehrere = und ein Leerzeichen vor den Absatz, um ihn als Überschrift auszuzeichnen.
=_ h1
==_ h2
===_ h3
Absätze, Zeilen
Absätze müssen im Editor immer als zwei Zeilen geschrieben werden.
Dadurch wird die Arbeit im Editor übersichtlicher und die Versionierung in GitHub wird einfacher.
-
ein einfacher Zeilenumbruch wird ignoriert: Der Text wird weitergeschrieben.
-
einen Zeilenumbruch können Sie mit
Leerzeichen +am Zeilenende erreichen -
um mehrere Zeilen untereinander zu schreiben können Sie
[%hardbreaks]davor setzen
Fett, kursiv …
Sie können einzelne Worte oder Zeichen einfach formatieren:
-
Zeichen vorher und nachher eingeben oder
(*= fett |#= markiert |'= monospace) -
Text markieren und Tastenkombi drücken ⌘+* oder
-
Text markieren und im Menü wählen:
Bilder einbinden
Legen Sie die Bilddateien in den Projektordner > Medien.
Sie können ein Bild aus dem Dateimanager einfach an die richtige Stelle schieben (drag&drop). Das Bild wird mit dem richtigen Code eingefügt.
Sie können Optionen im Code ergänzen (zwischen den eckigen Klammern).
Sie können Bilder auch mit obigem Code einbauen:
-
Beim Tippen unterstützt der adoc Coach und schlägt entsprechende Codes, Dateinamen und Optionen vor.
-
:image:: ist ein Bild zwischen den Absätzen
-
:image: ist ein Inlinebild (im Textfluss)
-
float=right stellt das Bild rechts neben den Text
adoc Coach
Wenn Sie schreiben und adoc einen Code entdeckt, erscheint automatisch der adoc Coach und zeigt die Möglichkeiten an.
-
Sie können weiter schreiben oder
-
aus in der Liste scrollen und wählen
Sie können den adoc Coach jederzeit auch mit der Taste ESC anzeigen.
Anmerkungen darstellen
Sie können Hinweise, Tipps, Warnhinweise speziell formatiert darstellen.
Achtung: Je nach Stil werden die unterschiedlich dargestellt.
Andere Hinweise: [NOTE] [IMPORTANT] [WARNING] [CAUTION]
Codeblöcke
Sie können Code in einem Codeblock darstellen.
Der Code wird im Codeblock automatisch formatiert (je nach source).
Tasten im Text darstellen
Sie können Tasten im Text einfach als Tasten darstellen.
Benutzen Sie das Makro kbd:[]
Menüpunkte auszeichnen
Sie können Menüpfade im Text grafisch formatieren.
Die grafische Darstellung hängt vom Stil ab!
Impressum
Dieses Snipbook ist ein Muster, um zu zeigen, wie ein Snipbook als Quickguide oder Tutorial eingesetzt werden kann.
© 2025 Dietrich Juhl | www.juhl.de | dietrich@juhl.de
Ende