web-dev-qa-db-fra.com

Comparez et contrastez les langages de balisage légers

Veuillez identifier les langages de balisage légers les plus populaires et comparer leurs forces et leurs faiblesses. Ces langages devraient être un balisage général pour la prose technique, comme pour la documentation (par exemple, Haml ne compte pas).

Voir aussi: Markdown versus ReStructuredText

documentationmarkdownmarkuprestructuredtexttextile
90
JasonSmith

Je connais trois langues principales utilisées couramment dans la grande communauté de programmation et de technologie: Textile, Markdown et reStructuredText. Tous les trois peuvent être appris en quelques heures ou "ailés" avec la feuille de triche à proximité.

Textile

  • Utilisé par Redmine et la communauté Ruby
  • 113 questions actuellement marquées sur Stack Overflow
  • La source la plus similaire au HTML, mais la moins lisible
  • Listes imbriquées les plus faciles des trois langues
  • Incompréhensible pour les non-programmeurs ou les ignorants du HTML
  • Idéal pour les documents courts complexes (avec liens, listes imbriquées, code, HTML personnalisé); par exemple: documentation courte, procédures, contenu de blog ou CMS
  • référence de syntaxe

Réduction

  • Ne semble pas avoir de "communauté" de langue maternelle mais ...
  • 1274 questions taggées sur Stack Overflow *
  • Souligne la lisibilité du code source, similaire aux traditions de messagerie
  • Intégration HTML simple (il suffit de taper les balises)
  • Aucun moyen de créer des tableaux en plus d'incorporer du HTML
  • Vous le savez déjà si vous connaissez Stack Overflow
  • Facile à apprendre si vous connaissez déjà reStructuredText
  • Obfuscation automatique de l'adresse e-mail pour le format <[email protected]> (avec crochets)
  • référence de syntaxe

reStructuredText (A.K.A. ReST)

  • Populaire dans la communauté Python
  • 285 questions marquées sur Stack Overflow
  • Un peu persnickety sur les espaces blancs et l'alignement si vous me demandez
  • Les listes (en particulier les listes imbriquées) et les paragraphes semblent toujours se disputer
  • Lisible par des non-programmeurs
  • Seul format pouvant construire une table des matières (via une extension dans l'implémentation de référence Python)
  • Convertit directement vers d'autres formats comme PDF et XML
  • Idéal pour les gros documents avec beaucoup de prose (par exemple une alternative au docbook pour un manuel d'utilisation)
  • référence de syntaxe
115
JasonSmith

Vous pourriez également envisager asciidoc

  • balisage relativement lisible
  • utilisation simple en ligne de commande
  • certains pourraient le percevoir comme relativement difficile (par rapport à flexible) en ce qui concerne la syntaxe
  • docbook et sortie (x) html
31
dat

La page Wikipedia sur langages de balisage légers a une bonne comparaison entre les différentes options, ainsi que la syntaxe des utilisations courantes (en-têtes, gras, italique, etc.)

21
technomalogical

J'essaie de couvrir tous les différents langages de balisage légers ici:

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

Comme vous pouvez le voir, cela a commencé par "comment puis-je créer un blog sécurisé" - c'est-à-dire qui génère du HTML statique, et je me suis retrouvé pris au piège dans les langages de balisage, les systèmes de modèles, etc.

Mise à jour

Je me suis recentré uniquement sur les LWML avec des implémentations python, et elles sont ici:

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

Jusqu'à présent, j'ai essayé le markdown et ReST, et j'aime mieux ce dernier pour tout sauf les extraits HTML intégrés dans d'autres pages. Tableaux, références croisées, liens indirects, etc ...

5
Travis H.

pour la documentation? que diriez-vous doxygen ?
Je l'ai utilisé pour certains projets c/c ++ que je dois documenter. Même vous pouvez en abuser, tout comme l'auteur de doxygen l'utilise pour la documentation de doxygen

4
mhd