Domanda

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

Vedi anche: Markdown versus ReStructuredText

È stato utile?

Soluzione

Conosco tre lingue principali usate comunemente nella grande comunità della programmazione e della tecnologia: Textile, Markdown e reStructuredText. Tutti e tre possono essere appresi in un paio d'ore o & Quot; alato & Quot; con il cheat sheet nelle vicinanze.

Tessile

  • Utilizzato da Redmine e dalla community di Ruby
  • 113 domande attualmente taggate su Stack Overflow
  • La fonte più simile all'HTML, ma meno leggibile
  • Elenchi nidificati più semplici di tutte e tre le lingue
  • Non comprensibile ai non programmatori o agli ignoranti HTML
  • Ideale per documenti brevi complessi (con collegamenti, elenchi nidificati, codice, HTML personalizzato); ad esempio: breve documentazione, tutorial, blog o contenuti CMS
  • Riferimento della sintassi

Markdown

  • Non sembra avere una lingua di origine " community " ma ...
  • 1274 domande taggate su Stack Overflow *
  • Enfatizza la leggibilità del codice sorgente, in modo simile alle tradizioni e-mail
  • Incorporamento HTML semplice (basta 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 < address@example.com > (con parentesi angolari)
  • Riferimento della sintassi

reStructuredText (A.K.A. ReST)

  • Popolare nella comunità Python
  • 285 domande taggate su Stack Overflow
  • Un po 'perspicace riguardo agli spazi bianchi e all'allineamento se me lo chiedi
  • Elenchi (in particolare elenchi nidificati) e paragrafi sembrano sempre litigare
  • Leggibile da non programmatori
  • Solo formato in grado di 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 al docbook per un manuale utente)
  • Riferimento sintassi

Altri suggerimenti

Potresti anche considerare asciidoc

  • markup relativamente leggibile
  • uso diretto della riga di comando
  • alcuni potrebbero percepirlo come relativamente "schizzinoso" (rispetto a flessibile) rispetto alla sintassi
  • docbook e (x) output HTML

La pagina di Wikipedia su linguaggi di markup leggeri ha anche un buon confronto tra le varie opzioni, come mostrando la sintassi per usi comuni (titoli, grassetto, corsivo, ecc.)

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 " - cioè uno che genera HTML statico e mi sono trovato invischiato in linguaggi di markup, sistemi di template, ecc.

Aggiorna

Mi sono rifocalizzato 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 mi piace il secondo meglio di tutto Snippet HTML incorporati in altre pagine. Tabelle, riferimenti incrociati, collegamenti indiretti, ecc ...

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

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top