Question

Identifiez les langages de balisage légers les plus populaires et comparez leurs forces et leurs faiblesses. Ces langages doivent être des balises à usage général pour la prose technique, comme pour la documentation (par exemple, Haml ne compte pas).

Voir aussi: Markdown versus ReStructuredText

Était-ce utile?

La solution

Je connais trois principaux langages couramment utilisés dans la grande communauté de la programmation et des technologies: 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
  • Les listes les plus simples imbriquées des trois langues
  • Incompréhensible pour les non-programmeurs et les ignorants du HTML
  • Idéal pour les documents courts complexes (avec liens, listes imbriquées, code, HTML personnalisé); par exemple: brève documentation, procédures, contenu de blog ou de CMS
  • Référence de la syntaxe

Markdown

  • Il ne semble pas y avoir de langue à la maison & "; communauté &"; mais ...
  • 1274 questions marquées sur Stack Overflow *
  • Accentue la lisibilité du code source, similaire aux traditions de messagerie
  • Intégration HTML simple (il vous suffit de taper les balises)
  • Pas moyen de faire des tableaux en plus d'intégrer du HTML
  • Vous le savez déjà si vous connaissez le débordement de pile
  • Facile à apprendre si vous connaissez déjà reStructuredText
  • obscurcissement automatique des adresses e-mail pour le format < address@example.com > (avec équerres)
  • Référence de la syntaxe

reStructuredText (A.K.A. ReST)

  • Populaire dans la communauté Python
  • 285 questions marquées sur le dépassement de capacité
  • Un peu de perspicacité à propos des espaces et de l’alignement si vous me demandez
  • Les listes (en particulier les listes imbriquées) et les paragraphes semblent toujours se disputer
  • lisible par les non-programmeurs
  • Seul format permettant de construire une table des matières (via une extension dans l'implémentation de référence Python)
  • Convertit directement vers d'autres formats tels que PDF et XML
  • Idéal pour les documents volumineux contenant beaucoup de prose (par exemple, une alternative à docbook pour un manuel d'utilisation)
  • Référence de la syntaxe

Autres conseils

Vous pouvez également envisager de asciidoc

  • balises relativement lisibles
  • utilisation directe en ligne de commande
  • certains pourraient le percevoir comme relativement «difficile» (vs flexible) en ce qui concerne la syntaxe
  • docbook et sortie (x) html

La page Wikipedia sur les langages de balisage légers offre une bonne comparaison entre les différentes options, ainsi que indiquant la syntaxe des utilisations courantes (titres, gras, italique, etc.)

J'essaie de couvrir tous les langages de balisage légers suivants:

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

Comme vous pouvez le constater, cela a commencé avec & "comment puis-je créer un blog sécurisé &"; - c’est-à-dire un 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 templates, etc.

Mettre à jour

Je me suis reconcentré uniquement sur les LWML implémentés en python, et les voici:

http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html< a>

Jusqu'à présent, j'ai essayé le démarquage et le ReST, et j'aime ce dernier mieux Extraits de code HTML incorporés dans d'autres pages. Tableaux, références croisées, liens indirects, etc ...

pour la documentation? que diriez-vous de doxygen ?
Je l’utilise pour certains projets c / c ++ que j’ai besoin de documenter. Même si vous pouvez "abuser" de la même manière que doxygen author utilise pour la documentation doxygen

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top