Pregunta

Identifique los lenguajes de marcado ligeros más populares y compare sus fortalezas y debilidades. Estos lenguajes deberían ser marcas de uso general para la prosa técnica, como para la documentación (por ejemplo, Haml no cuenta).

Consulte también: Markdown versus ReStructuredText

¿Fue útil?

Solución

Conozco tres lenguajes principales que se usan 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 & Quot; alado & Quot; con la hoja de trucos cerca.

Textil

  • Usado por Redmine y la comunidad Ruby
  • 113 preguntas etiquetadas actualmente en Stack Overflow
  • La fuente más similar a HTML, pero menos legible
  • Las listas anidadas más fáciles de los tres idiomas
  • No 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, instrucciones, blog o contenido de CMS
  • Referencia de sintaxis

Markdown

  • No parece tener un idioma del hogar " community " pero ...
  • 1274 preguntas etiquetadas en Stack Overflow *
  • Destaca la legibilidad del código fuente, similar a las tradiciones de correo electrónico
  • Incrustación HTML sencilla (simplemente escribe las etiquetas)
  • No hay forma de crear tablas además de incrustar HTML
  • Ya lo sabes si sabes 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 < address@example.com > (con corchetes angulares)
  • Referencia de sintaxis

reStructuredText (A.K.A. ReST)

  • Popular en la comunidad de Python
  • 285 preguntas etiquetadas en Desbordamiento de pila
  • Un poco perspicaz sobre los espacios en blanco y la alineación si me preguntas
  • Las listas (especialmente las listas anidadas) y los párrafos siempre parecen pelear
  • Legible por no programadores
  • Solo 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

Otros consejos

También puede considerar asciidoc

  • marcado relativamente legible
  • uso directo de línea de comandos
  • algunos podrían percibirlo como relativamente 'quisquilloso' (vs. flexible) con respecto a la sintaxis
  • docbook y (x) salida html

La página de Wikipedia en lenguajes de marcado ligeros también tiene una buena comparación entre las diversas opciones como muestra la sintaxis para usos comunes (encabezados, negrita, cursiva, etc.)

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 genera HTML estático, y me encontré atrapado en lenguajes de marcado, sistemas de plantillas, etc.

Update

Volví a centrarme 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 este último para todo menos Fragmentos de HTML incrustados en otras páginas. Tablas, referencias cruzadas, enlaces indirectos, etc ...

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

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top