documentation - tipos - Compara y contrasta los lenguajes de marcado ligero
yaml archivo (5)
Conozco tres idiomas principales utilizados comúnmente en la comunidad de programación y tecnología más grande: Textil, 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 de Ruby
- 113 preguntas actualmente etiquetadas en Stack Overflow
- La fuente más similar a HTML, pero menos legible
- Las listas anidadas más sencillas de los tres idiomas
- No comprensible para los no programadores o el HTML ignorante
- 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" de lengua materna, pero ...
- 1274 preguntas etiquetadas en Stack Overflow *
- Hace hincapié en la legibilidad del código fuente, similar a las tradiciones de correo electrónico
- Incrustación directa de HTML (simplemente escriba las etiquetas)
- No hay forma de hacer tablas además de incrustar HTML
- Ya lo sabes si sabes Stack Overflow
- Fácil de aprender si ya sabes reStructuredText
- Ofuscación automática de direcciones 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 perspicaz sobre el espacio en blanco y la alineación si me preguntas
- Las listas (especialmente las listas anidadas) y los párrafos siempre parecen entrar en peleas
- Legible por no programadores
- Solo formato que puede generar una tabla de contenidos (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
Identifique los lenguajes de marcado ligero más populares y compare sus fortalezas y debilidades. Estos lenguajes deben ser marcas generales para prosa técnica, como la documentación (por ejemplo, Haml no cuenta).
Ver también: Markdown versus ReStructuredText
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 crear un blog seguro", es decir, uno que genere HTML estático, y me encontré atrapado en lenguajes de marcas, sistemas de plantillas, etc.
Actualizar
Me reenfoqué solo en LWML con implementaciones de Python, y están aquí:
http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html
Hasta ahora he intentado con rebajas y ReST, y me gusta más este último para cualquier cosa que no sean fragmentos HTML incrustados en otras páginas. Tablas, referencias cruzadas, enlaces indirectos, etc.
La página de Wikipedia sobre lenguajes de marcado ligero tiene una buena comparación entre las diversas opciones, así como también muestra la sintaxis para usos comunes (encabezados, negrita, cursiva, etc.)
También podrías considerar asciidoc
- marcado relativamente legible
- uso directo de línea de comandos
- algunos pueden percibirlo como relativamente "quisquilloso" (frente a flexible) con respecto a la sintaxis
- docbook y (x) salida html