• [^] # Re: Aaaah Docbook...

    Posté par . En réponse au journal DocBook ou l'art d'écrire de la documentation. Évalué à 2. Dernière modification le 03 février 2017 à 20:49.

    ça dépends des gens

    Il y a moins de chance de faire une fôte de frappe sur ``` ou .... (et ça va plus vite à taper) qu’écrire <code>, je trouve :)

    Ensuite, en précisant le langage, pour profiter de la coloration syntaxique, qui est selon moi un must pour de la documentation technique, et bien tu sais en lisant le source que tu as affaire à du code (c’est même plus précis que le mot « code » lui même...)

    En asciidoc ça donne :

    [source,ruby]
----
require 'sinatra' // <1>
get '/hi' do // <2>
 "Hello World!" // <3>
end
----

    et tu peux utiliser le nombre de tiret que tu veux, tu peux en mettre plein pour que ce soit plus lisible en texte brut (ou pouvoir avoir des lignes telles que '----' à l’intérieur du bloc...

    et là en markdown pour le coup c’est simplifié au maximum : ```ruby

    http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#source-code

    L’exemple m’a bien fait rire :

    error: The requested operation returned error: 1954 Forbidden search for defensive operations manual
absolutely fatal: operation initiation lost in the dodecahedron of doom
would you like to die again? y/n