AsciiDoc
| AsciiDoc | ||
|---|---|---|
| https://asciidoc.org/ | ||
| Información general | ||
| Extensión de archivo | txt, adoc y asciidoc | |
| Tipo de MIME | text/asciidoc | |
| Lanzamiento inicial | 2002 | |
| Formato abierto | ? | |
AsciiDoces unlenguaje de marcado de documentos ligero,semánticamente equivalente aDocBook,pero usando sintaxis de texto plano en vez deXML.Los documentos en AsciiDoc pueden ser creados usando cualquier editor de textos, y leídos de la misma forma; y también renderizados a HTML o cualquier otro formato soportado por una toolchain de DocBook:PDF,TeX,o páginas del manual, por ejemplo.[1]
Las extensiones de archivo más comunes para un documento AsciiDoc sontxt(que es la que el creador de AsciiDoc recomienda) yadoc.[2][3]
Historia
[editar]AsciiDoc fue creado en 2002 porStuart Rackham,quien publicó unas herramientas (‘asciidoc’ y ‘a2x’) escritas enPythonpara convertir texto plano, en un formato "legible para humanos" a alguno de los formatos comúnmente utilizados en la publicación.[1]
Asciidoctor
[editar]Una implementación escrita enRuby,llamada "Asciidoctor", publicada en 2013, es la más popular de las implementaciones, y es usada porGitHub[4] yGitLab.[5] Esta implementación también está disponible en el ecosistema de Java, usandoJRuby,y en el deJavaScriptmediante Opal.js.
Algunos de los libros, físicos y electrónicos, deO'Reilly Mediafueron escritos usando marcado AsciiDoc.[6]
La mayor parte de la documentación deGitestá escrita usando AsciiDoc.[7]
El formato AsciiDoc está actualmente bajo un proceso de estandarización dirigido por laEclipse Foundation.[8][9]
Ejemplo
[editar]La siguiente tabla muestra un texto formateado en AsciiDoc, y un renderizado similar al que produciría un procesador de AsciiDoc:
| Texto en AsciiDoc |
|---|
= My Article
J. Smith
https://wikipedia.org[Wikipedia]is an
on-line encyclopedia, available in
English and *many* other languages.
== Software
You can install 'package-name' using
the`gem`command:
gem install package-name
== Hardware
Metals commonly used include:
*copper
*tin
*lead
|
| Resultado renderizado |
|---|
|
J. Smith Wikipediais an on-line encyclopedia, available in English andmanyother languages. You can installpackage-nameusing thegemcommand: gem install package-name Metals commonly used include:
|
Herramientas
[editar]- Antora– un generador de sitios de documentación multirepositorio que usagit.
- awestruct– un generador de sitios estáticos inspirado enJekyll.
- Asciidoc FX– un editor de libros en AsciiDoc que usa JavaFX 8.
- AsciiDocLIVE– un editor de AsciiDoc en línea.
- DAPS– DocBook Authoring and Publishing Suite (DAPS) un sistema de línea de comandos para publicar documentos DocBook y AsciiDoc como HTML, PDF, y EPUB.
Véase también
[editar]Referencias
[editar]- ↑ab«AsciiDoc».Archivado desdeel originalel 3 de marzo de 2016.Consultado el 18 de octubre de 2013.
- ↑«AsciiDoc Frequently Asked Questions».asciidoc.org(en inglés).Consultado el 23 de febrero de 2024.
- ↑«AsciiDoc Recommended Practices | Asciidoctor».asciidoctor.org(en inglés).Consultado el 23 de febrero de 2024.
- ↑«AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories».Asciidoctor(en inglés).
- ↑«Asciidoc».GitLab User Docs(en inglés).Archivado desdeel originalel 22 de julio de 2019.Consultado el 6 de febrero de 2020.
- ↑«AsciiDoc 101 (chapter 4 of Getting Started with Atlas)».Author Welcome Kit(en inglés).O'Reilly Media. Archivado desdeel originalel 14 de octubre de 2017.Consultado el 19 de mayo de 2016.
- ↑«Git wiki»(en inglés).Git SCM.Consultado el 23 de febrero de 2024.
- ↑«AsciiDoc Language».27 de julio de 2020.Consultado el 23 de febrero de 2024.
- ↑«AsciiDoc Working Group Charter».Consultado el 23 de febrero de 2024.
Enlaces externos
[editar]- Sitio web oficial
- Using AsciiDoc and Asciidoctor to write documentation- An AsciiDoc Tutorial (en inglés)