Documents i manuals tècnics amb Asciidoctor

Documents i manuals tècnics amb Asciidoctor

De Markdown a Asciidoc, i d'Asciidoc ara a Asciidoctor per tal de documentar documents i manuals tècnics d'una manera ràpida, senzilla i generant PDFs o HTML 5 responsive. Una meravella. Ja dubto de si m'agrada més LaTeX o aquest Asciidoctor.

Doncs bé, si volem instal·lar Asciidoctor a FreeBSD, ens instal·larà unes llibreries de Ruby. Ho fem amb:

# pkg install rubygem-asciidoctor

He generat el document HTML5 a partir de quart.adoc amb:

asciidoctor -b html5 -a stylesheet=colony.css quart.adoc

També he generat un Docbook amb:

asciidoctor -b html5 -a stylesheet=foundation-lime.css quart.adoc

Web oficial del projecte Asciidoc
http://asciidoc.org/manpage.html

Asciidoctor cheat sheet al Github
https://github.com/powerman/asciidoc-cheatsheet

Podem probar AsciiDoc en línia
https://asciidoclive.com/edit/scratch/1

Algunes captures de themes per al format HTML
https://darshandsoni.com/asciidoctor-skins/screenshots/

Per a l'atribut de la taula de continguts, podem ficar: auto / left / right / preamble / macro.

Ací tenim els themes:
http://themes.asciidoctor.org/stylesheets/colony.css (CLARET TAMBÉ)
http://themes.asciidoctor.org/stylesheets/golo.css (XULO)
http://themes.asciidoctor.org/stylesheets/asciidoctor.css (PER DEFECTE)
http://themes.asciidoctor.org/stylesheets/foundation.css (NEGRET)
http://themes.asciidoctor.org/stylesheets/foundation-lime.css (KIWI)
http://themes.asciidoctor.org/stylesheets/foundation-potion.css (DIPCAS)
http://themes.asciidoctor.org/stylesheets/iconic.css (CAPÇALERA NEGRA)
http://themes.asciidoctor.org/stylesheets/maker.css (MINIMALISTA ROGET)
http://themes.asciidoctor.org/stylesheets/readthedocs.css (XULO NEGRET I MODERN)
http://themes.asciidoctor.org/stylesheets/riak.css (GRISET MINIMALISTA)
http://themes.asciidoctor.org/stylesheets/rubygems.css (NEGET)

Doncs bé això és tot, espere que trobes útil aquest article i que et motive a compartir els teus trucs, els teus coneixements i els teus experiments amb el Programari Lliure. Pensa-ho, va, que la Comunitat del Programari Lliure va creixent gràcies a la documentació, el disseny, la formació o la programació, sigues part de la Comunitat :-)

La cultura i la lliure circulació de les idees és l'arma més efectiva contra les dictadures del pensament i contra la ignorància.

Utilitats

NAVEGACIÓ SENSE RATOLÍ

- Tab següent enllaç.
- Shift+Tab anterior enllaç.
- Enter activa l'enllaç.
- Alt+esquerra anar arrere.

CONTRAST DE COLORS

Accessibilitat - Color Negre
Accessibilitat - Color Groc
Accessibilitat - Color Verd

Accessibilitat - Color Blau
Accessibilitat - Color Crema
Accessibilitat - Color Blanc

 

PORTADES ALTERNATIVES