On Tue, Feb 11, 2020 at 9:03 AM bruno bossola [email protected]
[it-torino-java-jug] <[email protected]> wrote:

>
>
> Ciao a tutti,
>
> Qualcuno può consigliare un tool gratuito x realizzare un sito di
> documentazione che sia più facilmente mantenibile? Oltre al codice, servono
> anche le istruzioni per l'uso ;)
>
>
>
Ho usato sia https://www.gitbook.com/ che https://asciidoctor.org/

gitbbook non lo avevo scelto, mi sono adeguato. E' pensato per scrivere
libri, puoi generare html e pdf, usa MK

ascidoctor l'ho scelto. Penso sia migliore per documentare progetti sw,
anche perche' puoi includere snippet di codice direttamente dai sorgenti,
e' sufficiente annotare i sorgenti stessi: niente piu' codice obsoleto/non
funzionante nella documentazione
Ovviamente usa AsciiDoc come formato.
Un progetto a caso che lo usa:
https://junit.org/junit5/docs/current/user-guide/
Con il plugin maven generi sia html che pdf.

Ho una conf di maven che permette anche il jetty:run, te la metto su github
per 2 birre al BrewDog

FRANK
-- 
Roberto Franchini
"The impossible is inevitable"
https://github.com/robfrank/
https://twitter.com/robfrankie
https://www.linkedin.com/in/robfrank

Reply via email to