AsciiDoc

Formato de documento legible para humanos

AsciiDoc es un formato de documento legible por humanos , semánticamente equivalente a DocBook XML , pero que utiliza convenciones de marcado de texto simple . Los documentos AsciiDoc se pueden crear utilizando cualquier editor de texto y leerse "tal como están", o renderizarse a HTML o cualquier otro formato compatible con una cadena de herramientas DocBook, es decir, PDF , TeX , páginas de manual de Unix , libros electrónicos , presentaciones de diapositivas, etc. ^[3] Las extensiones de archivo comunes para los archivos AsciiDoc son (como lo recomienda el creador de AsciiDoc) y . ^{[4] [5]} txtadoc

Historia

AsciiDoc fue creado en 2002 por Stuart Rackham, quien publicó herramientas ('asciidoc' y 'a2x'), escritas en el lenguaje de programación Python para convertir archivos de texto simple, 'legibles para humanos', a formatos de documentos publicados de uso común. ^[3]

Asciidoctor

GitHub ^[6] y GitLab ^[7] utilizan una implementación de Ruby llamada 'Asciidoctor', lanzada en 2013. Esta implementación también está disponible en el ecosistema Java usando JRuby y en el ecosistema JavaScript usando Opal.js.

Algunos de los libros y libros electrónicos de O'Reilly Media están creados utilizando el marcado AsciiDoc. ^[8]

La mayor parte de la documentación del proyecto Git está escrita en AsciiDoc. ^[9]

El formato AsciiDoc se encuentra actualmente en proceso de estandarización por parte de la Fundación Eclipse . ^{[10] [11]}

Ejemplo

A continuación se muestra un texto que utiliza el marcado AsciiDoc y una representación similar a la producida por un procesador AsciiDoc:

Herramientas

• Antora – un generador de sitios de documentación de múltiples repositorios para escritores técnicos que usan git .
• AsciiBinder – (obsoleto) un sistema de documentación creado en Asciidoctor para personas que tienen una gran cantidad de documentos que mantener y republicar periódicamente.
• awestruct – un generador de sitios estáticos inspirado en Jekyll .
• Asciidoc FX – Editor de libros AsciiDoc basado en JavaFX 8.
• AsciiDocLIVE – AsciiDocLIVE es un editor AsciiDoc en línea gratuito.
• DAPS – DocBook Authoring and Publishing Suite (DAPS) es un software de línea de comandos para publicar DocBook y AsciiDoc como HTML, PDF y EPUB.

Véase también

• Portal de software libre y de código abierto

• Reducción
• Comparación de generadores de documentación
• Lenguaje de marcado ligero

Referencias

1. "Versión 10.2.1". 17 de julio de 2024. Consultado el 21 de julio de 2024 .
2. "Versión 2.0.23". 17 de mayo de 2024. Consultado el 20 de mayo de 2024 .
3. "AsciiDoc". Archivado desde el original el 3 de marzo de 2016. Consultado el 18 de octubre de 2013 .
4. "Preguntas frecuentes sobre AsciiDoc". asciidoc.org . Consultado el 20 de marzo de 2020 .
5. "Prácticas recomendadas de AsciiDoc | Asciidoctor". asciidoctor.org . Consultado el 20 de marzo de 2020 .
6. "AsciiDoc, desarrollado por Asciidoctor, regresa a GitHub y a sus más de 5 millones de repositorios".
7. "Asciidoc". Documentación de usuario de GitLab . Archivado desde el original el 22 de julio de 2019. Consultado el 6 de febrero de 2020 .
8. "AsciiDoc 101 (capítulo 4 de Introducción a Atlas)". Kit de bienvenida al autor . O'Reilly Media. Archivado desde el original el 14 de octubre de 2017 . Consultado el 19 de mayo de 2016 .
9. "Wiki de Git". SCM de Git.
10. "Lenguaje AsciiDoc". 27 de julio de 2020.
11. "Carta del Grupo de Trabajo AsciiDoc".

Enlaces externos

• Sitio web oficial
• https://asciidoctor.org/
• Cómo usar AsciiDoc y Asciidoctor para escribir documentación: tutorial de AsciiDoc