Frage

Bitte geben Sie die beliebtesten leichte Auszeichnungssprachen und ihre Stärken und Schwächen vergleichen. Diese Sprachen sollten Allzweck- Markup für technische Prosa sein, wie für die Dokumentation (zum Beispiel Haml zählt nicht).

Siehe auch: Markdown gegen ReStructuredText

War es hilfreich?

Lösung

Ich kenne drei Sprachen, die allgemein in der größeren Programmierung und Tech-Community verwendet: Textile, Markdown, und reStructuredText. Alle drei können in der Nähe in ein paar Stunden oder „geflügelten“ mit dem Spickzettel erlernt werden.

Textile

  • Wird von Redmine und die Ruby-Community
  • 113 Fragen zur Zeit markiert auf Stack-Überlauf
  • Die meisten ähnlich wie HTML, aber am wenigsten lesbare Quelle
  • Einfachste verschachtelte Listen aller drei Sprachen
  • Nicht verständlich zu Nicht-Programmierer oder der HTML-unwissend
  • Ideal für komplexe kurze Dokumente (mit Links, verschachtelten Listen, Code, benutzerdefinierte HTML); zum Beispiel: kurze Dokumentation, How-tos, Blog oder CMS-Inhalte
  • Syntax Referenz

Markdown

  • Scheint kein Zuhause Sprache „Gemeinschaft“ zu haben, aber ...
  • 1274 Fragen der Etikette auf Stack-Überlauf *
  • Quellcode Lesbarkeit betont, ähnliche Traditionen zu E-Mail
  • Einfache HTML-Einbettung (Sie nur die Tags tippen)
  • No way Tabellen machen neben HTML einbetten
  • Sie wissen es bereits, wenn Sie wissen Stack-Überlauf
  • Einfach zu erlernen, wenn Sie bereits wissen reStructuredText
  • Automatische E-Mail-Adresse Verschleierung für das Format (mit spitzen Klammern)
  • Syntax Referenz

reStructuredText (auch bekannt als ReST)

  • Popular in der Python-Community
  • 285 Fragen markiert auf Stack-Überlauf
  • Ein bisschen pingelig über Leerzeichen und Ausrichtung, wenn Sie mich fragen,
  • Listen (insbesondere verschachtelte Listen) und Absätze scheinen immer in Kämpfe zu bekommen
  • Lesbare von Nicht-Programmierern
  • Nur Format, das ein Inhaltsverzeichnis (über eine Erweiterung in der Python-Referenz-Implementierung) bauen
  • wandelt direkt in anderen Formaten wie PDF und XML
  • Ideal für große Dokumente mit vielen Prosa (zum Beispiel einer Alternative für eine Bedienungsanleitung in DocBook)
  • Syntax Referenz

Andere Tipps

Sie auch interessieren könnten asciidoc

  • relativ lesbarer Markup
  • einfache Befehlszeilen Verwendung
  • einige könnten es wahrnehmen als relativ ‚wählerisch‘ (gegenüber flexibel) in Bezug auf Syntax
  • DocBook und (x) HTML-Ausgabe

Die Wikipedia-Seite über leichte Auszeichnungssprachen einen guten Vergleich zwischen den verschiedenen Optionen, wie auch so zeigt Syntax für gemeinsame Nutzung (Überschriften, fett, kursiv, etc.)

Ich versuche, hier all die verschiedenen leichten Auszeichnungssprachen abdecken:

http://www.subspacefield.org/~travis/static_blog_generators.html

Wie Sie sehen können, begann es mit „wie kann ich einen sicheren Blog“ - das heißt eine, die statischen HTML-Code generiert, und ich fand ich in Markup-Sprachen verstrickt, Templating Systeme etc

.

Aktualisieren

I neu fokussiert nur auf LWMLs mit Python-Implementierungen, und theyre hier:

http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html

Bisher habe ich versucht Abschlags und ReST, und Ich mag diese besser für alles andere als HTML-Schnipsel in anderen Seiten eingebettet. Tabellen, Kreuz Refs, indirekte Links, etc ...

für die Dokumentation? wie etwa doxygen ?
Ich habe es von c / c für einige verwenden ++ Projekt, das ich documentize benötigen. Auch können Sie ‚missbrauchen‘ es wie doxygen Autor verwendet für doxygen Dokumentation

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top