Commit 1e6fceb7 authored by Elena Grandi's avatar Elena Grandi
Browse files

Style guidelines

parent 7ad3809c
......@@ -92,3 +92,28 @@ Se non si ha accesso in scrittura al repository si può invece creare una
`merge request`_
.. _`merge request`: https://gitlab.com/help/user/project/merge_requests/index.md
Linee di guida per lo stile
===========================
Screenshot ed esempi di terminale
---------------------------------
Per guide che si riferiscono a programmi grafici, è opportuno aggiungere
screenshot.
Per quanto riguarda esempi tratti dal terminale, meglio riportare
comandi ed output come testo, per maggiore accessibilità, usando dei
blocchi di codice, ad esempio::
testo introduttivo::
$ comando
output del comando
# /sbin/comando
output del comando lanciato da root
.. note:: I doppi due punti del codice reStructuredText vengono
convertiti in un punto unico nelle versioni pubblicate, a meno che non
sia preceduto da spazi (o in un paragrafo da solo), nel qual caso
viene rimosso.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment