AsciiDoc es un formato de documento legible por humanos , semánticamente equivalente a DocBook XML , pero que utiliza convenciones de marcado de texto sin formato . Los documentos AsciiDoc pueden crearse usando cualquier editor de texto y leerse "tal cual", 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. [1] Las extensiones de archivo comunes para los archivos AsciiDoc son (como recomienda el creador de AsciiDoc) y . [2] [3] txt
adoc
Versión inicial | 2002 |
---|---|
¿ Formato abierto ? | sí |
Sitio web | asciidoc |
Autor (es) original (es) | Stuart Rackham |
---|---|
Desarrollador (es) | Matthew Peveler, Dan Allen, Michel Krämer y col. |
Versión inicial | 25 de noviembre de 2002 |
Lanzamiento estable | 9.0.5 / 24 de enero de 2021 |
Repositorio | github |
Escrito en | Pitón |
Sistema operativo | Multiplataforma |
Tipo | Generador de documentación |
Licencia | GPL v2 |
Sitio web | asciidoc |
Autor (es) original (es) | Ryan Waldron |
---|---|
Desarrollador (es) | Dan Allen, Sarah White y col. |
Versión inicial | 30 de enero de 2013 |
Lanzamiento estable | 2.0.15 / 27 de abril de 2021 |
Repositorio | github |
Escrito en | Rubí |
Sistema operativo | Multiplataforma |
Tipo | Generador de documentación |
Licencia | MIT |
Sitio web | asciidoctor |
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 sin formato, 'legibles por humanos' a formatos de documentos publicados comúnmente utilizados. [1]
GitHub [4] y GitLab utilizan una implementación de Ruby llamada 'Asciidoctor', lanzada en 2013 . [5] 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 se han escrito con el marcado AsciiDoc. [6]
La mayor parte de la documentación del proyecto Git está escrita en AsciiDoc. [7]
El formato AsciiDoc se encuentra actualmente en proceso de estandarización por parte de la Fundación Eclipse . [8] [9]
Ejemplo
A continuación, se muestra el texto con marcado AsciiDoc y una representación similar a la producida por un procesador AsciiDoc:
Texto fuente de AsciiDoc |
---|
= Mi artículoJ. Smithhttps://wikipedia.org [Wikipedia] es unaenciclopedia en línea, disponible enInglés y * muchos * otros idiomas.== SoftwarePuede instalar 'nombre de paquete' usandoel comando `gem` : gema instalar nombre-paquete== HardwareLos metales comúnmente utilizados incluyen:* cobre * estaño * plomo |
Resultado renderizado en HTML |
---|
J. Smith Wikipedia es una enciclopedia en línea, disponible en inglés y en muchos otros idiomas. Puede instalar el nombre del paquete usando el gemcomando: gema instalar nombre-paquete Los metales comúnmente utilizados incluyen:
|
Herramientas
- Antora : un generador de sitios de documentación de repositorios múltiples para escritores de tecnología que usan git .
- AsciiBinder : (obsoleto) un sistema de documentación construido en Asciidoctor para personas que tienen muchos documentos para mantener y volver a publicar de forma regular.
- 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.
Ver también
- Comparación de generadores de documentación
- Lenguaje de marcado ligero
Referencias
- ^ a b "AsciiDoc" . Archivado desde el original el 3 de marzo de 2016 . Consultado el 18 de octubre de 2013 .
- ^ "Preguntas frecuentes sobre AsciiDoc" . asciidoc.org . Consultado el 20 de marzo de 2020 .
- ^ "Prácticas recomendadas de AsciiDoc | Asciidoctor" . asciidoctor.org . Consultado el 20 de marzo de 2020 .
- ^ "AsciiDoc, impulsado por Asciidoctor, vuelve a GitHub y sus más de 5 millones de repositorios" .
- ^ "Asciidoc" . Documentos de usuario de GitLab . Consultado el 6 de febrero de 2020 .
- ^ "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 .
- ^ "Wiki de Git" . Git SCM.
- ^ "Lenguaje AsciiDoc" .
- ^ "Carta del Grupo de Trabajo AsciiDoc" .
enlaces externos
- Página web oficial
- https://asciidoctor.org/
- Uso de AsciiDoc y Asciidoctor para escribir documentación : un tutorial de AsciiDoc