talbinet / shareit-asciidoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Share-It AsciiDoc

1. Was ist AsciiDoc?

AsciiDoc ist eine plain text markup language. Der formale Standard, die Syntax, wenn man so will.

1.1. Was ist AsciiDoctor?

AciiDoctor ist die Implementierung von AsciiDoc. Die Referenzimplementierung ist in Ruby geschrieben, es gibt aber auch Varianten für Jave und JavaScript.

2. Warum Asciidoc?

geek-n-poke
  • Aus einer einzigen Quelle, können viele verschiedene Ausgabe-Formate erstellt werden.
    Darunter bspw: HTML5, PDF, RevealJS-Präsentationen, LeTeX, DocBook, Confluence, manpages uvm.

  • Einfach zugänglich und adoptierbar, d.h.

    • Ohne Spezialwerkzeuge gut lesbar und editierbar.

    • Gut versionierbar / mergebar / auf gerrit direkt editierbar

    • Gut integrierbar in vorhandene Build-Prozesse (Maven, gradle, npm)

    • Gute Unterstützung von vielen Text-Editoren und IDEs.

    • Kostenlos

    • schnell erlernbar

  • Erweiterbar

    • durch Extensions, also eigene Sprachelemente, die dann in die interne Objekt-Graph Representation übersetzt werden und dann von alle bacrkends verwendet werden können.

      • z.B. Diagramme (PlantUML, ditaa usw.)

      • z.B. asciidoc-Screenshot, WebDriver basierte autom. Screenshot-Tool

    • durch eigene Backends, also volle Kontrolle über die Ausgabe.

      • z.B. RevealJS, für Presentationen

  • Fühlt sich wie richtige Software-Entwicklung an

    • Try & Error

    • Unterstützung von Variablen & IF-Bedingungen

    • Ähnliche Werkzeug-Ketten

    • Continious Integration/Documentation

    • Einbettung von Quell-Code

    • Kommentare // :D

  • Vielseitig einsetzbar

    • Als Generator statischer Webseiten

    • Für PDF-Dokumente

    • Präsentationen

    • Online-Hilfen

    • uvm.

About


Languages

Language:Roff 86.4%Language:Java 9.0%Language:HTML 4.5%