Comparar y contrastar los lenguajes de marcas ligeros [cerrado]

90

Identifique los lenguajes de marcado ligero más populares y compare sus fortalezas y debilidades. Estos lenguajes deben tener un marcado de propósito general para la prosa técnica, como para la documentación (por ejemplo, Haml no cuenta).

Ver también: Markdown versus texto reestructurado

documentation markdown markup restructuredtext textile JasonSmith
fuente
1
Véase también superuser.com/questions/209897/text-formatter-tools/...
RedGrittyBrick

Respuestas:

115

Sé de tres lenguajes principales que se utilizan comúnmente en la gran comunidad de programación y tecnología: Textile, Markdown y reStructuredText. Los tres se pueden aprender en un par de horas o "alados" con la hoja de trucos cerca.

Textil

  • Utilizado por Redmine y la comunidad Ruby
  • 113 preguntas actualmente etiquetadas en Stack Overflow
  • La fuente más similar a HTML, pero menos legible
  • Listas anidadas más fáciles de los tres idiomas
  • No es comprensible para los no programadores o los ignorantes de HTML
  • Ideal para documentos cortos complejos (con enlaces, listas anidadas, código, HTML personalizado); por ejemplo: documentación breve, tutoriales, blog o contenido de CMS
  • Referencia de sintaxis

Reducción

  • No parece tener una "comunidad" en la lengua materna, pero ...
  • 1274 preguntas etiquetadas en Stack Overflow *
  • Enfatiza la legibilidad del código fuente, similar a las tradiciones del correo electrónico.
  • Incrustación de HTML sencilla (simplemente escriba las etiquetas)
  • No hay forma de crear tablas además de incrustar HTML
  • Ya lo sabes si conoces Stack Overflow
  • Fácil de aprender si ya conoce reStructuredText
  • Ofuscación automática de la dirección de correo electrónico para el formato <direcció[email protected]> (con corchetes angulares)
  • Referencia de sintaxis

reStructuredText (AKA ReST)

  • Popular en la comunidad de Python
  • 285 preguntas etiquetadas en Stack Overflow
  • Un poco quisquilloso con los espacios en blanco y la alineación si me preguntas
  • Las listas (especialmente las anidadas) y los párrafos siempre parecen meterse en peleas
  • Legible por no programadores
  • Único formato que puede construir una tabla de contenido (a través de una extensión en la implementación de referencia de Python)
  • Convierte directamente a otros formatos como PDF y XML
  • Ideal para documentos grandes con mucha prosa (por ejemplo, una alternativa al docbook para un manual de usuario)
  • Referencia de sintaxis
JasonSmith
fuente
4
Para los usuarios de ReST, sphinx.pocoo.org parece una herramienta muy buena para grandes colecciones de documentación de referencia estructuradas en árbol.
bendin
6
No tengo ningún problema con las listas y los párrafos en reStructuredText cuando ajusto las cosas en Emacs. De hecho, funcionan exactamente como esperaría que lo hicieran :-)
Martin Geisler
1
Hay extensiones de Markdown que permiten componer tablas en ASCII.
Jakub Narębski
1
ReST también tiene un excelente soporte para herramientas: por ejemplo, el navegador notex.ch es una buena herramienta con la que experimentar, aprender y usar ReST (basado en el backend sphinx.pocoo.org).
hsk81
31

También podría considerar el asciidoc

  • marcado relativamente legible
  • uso sencillo de la línea de comandos
  • algunos podrían percibirlo como relativamente 'quisquilloso' (frente a flexible) con respecto a la sintaxis
  • salida de docbook y (x) html
eso
fuente
2
Desafortunadamente, asciidoc tiene una sintaxis horrible para los elementos de lista con varios párrafos: debe separarlos con una sola línea que contenga solo un signo más (sí, un "+").
Martin Geisler
4
@Martin: ¿Son realmente tan importantes los elementos de la lista de varios párrafos? Si necesita más de un párrafo, ¿no serían más apropiados los encabezados / secciones que una lista?
Steve S
La mayor ventaja de AsciiDoc es que admite muchas más funciones. Se puede crear libros, tienen secciones de punta, muchas salidas ... powerman.name/doc/asciidoc
Wernight
21

La página de Wikipedia sobre lenguajes de marcado ligeros tiene una buena comparación entre las diversas opciones, además de mostrar la sintaxis para usos comunes (encabezados, negrita, cursiva, etc.)

tecnomagico
fuente
5

Estoy intentando cubrir todos los diversos lenguajes de marcado ligeros aquí:

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

Como puede ver, comenzó con "¿cómo puedo hacer un blog seguro?", Es decir, uno que genere HTML estático, y me encontré atrapado en lenguajes de marcado, sistemas de plantillas, etc.

Actualizar

Me enfoqué solo en LWML con implementaciones de Python, y están aquí:

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

Hasta ahora he probado Markdown y ReST, y me gusta más este último para cualquier cosa que no sean fragmentos de HTML incrustados en otras páginas. Tablas, referencias cruzadas, enlaces indirectos, etc ...

Travis H.
fuente
4

para la documentación? ¿qué tal el oxígeno ?
Lo he usado para algunos proyectos de c / c ++ que necesito documentar. Incluso usted puede 'abusar' de él como lo usa el autor de doxygen para la documentación de doxygen

mhd
fuente