Confronta e contrapponi i linguaggi di markup leggeri [chiuso]


90

Identifica i linguaggi di markup leggeri più popolari e confronta i loro punti di forza e di debolezza. Questi linguaggi dovrebbero essere markup di uso generale per la prosa tecnica, come per la documentazione (ad esempio, Haml non conta).

Vedi anche: Markdown versus ReStructuredText


Risposte:


115

Conosco tre linguaggi principali usati comunemente nella più ampia comunità di programmazione e tecnologia: Textile, Markdown e reStructuredText. Tutti e tre possono essere appresi in un paio d'ore o "alati" con il cheat sheet nelle vicinanze.

Tessile

  • Utilizzato da Redmine e dalla comunità Ruby
  • 113 domande attualmente contrassegnate su Stack Overflow
  • La sorgente più simile all'HTML, ma meno leggibile
  • Elenchi annidati più semplici di tutte e tre le lingue
  • Non comprensibile ai non programmatori o agli ignoranti di HTML
  • Ideale per documenti brevi complessi (con collegamenti, elenchi annidati, codice, HTML personalizzato); ad esempio: breve documentazione, how-to, blog o contenuto CMS
  • Riferimento alla sintassi

Markdown

  • Non sembra avere una "comunità" di lingua madre ma ...
  • 1274 domande taggate su Stack Overflow *
  • Enfatizza la leggibilità del codice sorgente, simile alle tradizioni della posta elettronica
  • Incorporamento HTML semplice (devi solo digitare i tag)
  • Non c'è modo di creare tabelle oltre a incorporare HTML
  • Lo sai già se conosci Stack Overflow
  • Facile da imparare se conosci già reStructuredText
  • Offuscamento automatico dell'indirizzo e-mail per il formato <indirizzo@esempio.com> (con parentesi angolari)
  • Riferimento alla sintassi

reStructuredText (AKA ReST)

  • Popolare nella comunità Python
  • 285 domande taggate su Stack Overflow
  • Un po 'perspicace sugli spazi bianchi e l'allineamento se me lo chiedi
  • Le liste (specialmente le liste annidate) ei paragrafi sembrano sempre entrare in conflitto
  • Leggibile da non programmatori
  • Unico formato che può creare un sommario (tramite un'estensione nell'implementazione di riferimento di Python)
  • Converte direttamente in altri formati come PDF e XML
  • Ideale per documenti di grandi dimensioni con molta prosa (ad es. Un'alternativa a docbook per un manuale utente)
  • Riferimento alla sintassi

4
Per gli utenti di ReST, sphinx.pocoo.org sembra uno strumento molto carino per grandi raccolte di documentazione di riferimento strutturate ad albero.
bendin

6
Non ho alcun problema con elenchi e paragrafi in reStructuredText quando inserisco le cose in Emacs. In effetti, funzionano esattamente come mi aspetto che facciano :-)
Martin Geisler,

1
Esistono estensioni a Markdown che consentono di comporre tabelle in ASCII.
Jakub Narębski

1
ReST ha anche un eccellente supporto per gli strumenti: ad esempio notex.ch basato su browser è un buon strumento con cui sperimentare, imparare e utilizzare ReST (basato sul backend sphinx.pocoo.org).
hsk81

31

Potresti anche considerare asciidoc

  • markup relativamente leggibile
  • semplice utilizzo da riga di comando
  • alcuni potrebbero percepirlo come relativamente "schizzinoso" (vs. flessibile) rispetto alla sintassi
  • docbook e (x) output html

2
Sfortunatamente asciidoc ha una sintassi orribile per gli elementi della lista con più paragrafi: devi separarli con una singola riga contenente solo un segno più (sì, un "+").
Martin Geisler,

4
@ Martin: gli elementi di un elenco a più paragrafi sono davvero così importanti? Se hai bisogno di più di un paragrafo, i titoli / le sezioni non sarebbero più appropriati di un elenco?
Steve S

Il più grande vantaggio di AsciiDoc è che supporta molte più funzionalità. Può creare libri, avere sezioni di suggerimenti, molti output ... powerman.name/doc/asciidoc
Wernight,


5

Sto tentando di coprire tutti i vari linguaggi di markup leggeri qui:

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

Come puoi vedere, è iniziato con "come posso creare un blog sicuro", ovvero uno che genera HTML statico, e mi sono ritrovato intrappolato in linguaggi di markup, sistemi di modelli, ecc.

Aggiornare

Mi sono concentrato solo su LWML con implementazioni Python e sono qui:

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

Finora ho provato markdown e ReST, e quest'ultimo mi piace di più per qualsiasi cosa tranne gli snippet HTML incorporati in altre pagine. Tabelle, riferimenti incrociati, collegamenti indiretti, ecc ...


4

per la documentazione? che ne dici di ossigeno ?
L'ho usato per alcuni dei progetti c / c ++ che ho bisogno di documentare. Anche tu puoi "abusarne" proprio come l'autore di doxygen usa per la documentazione di doxygen

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.