Vai al contenuto

Titolo 2.2↵

eros malesuada↵

et eleifend mi bibendum. Nunc ligula orci, aliquam vitae faucibus at, rhoncus vel risus. In sagittis gravida placerat. Sed gravida egestas leo, in accumsan neque sagittis quis. Curabitur vehicula velit ac sem rhoncus pulvinar. Vestibulum quis cursus ex.

Nulla maximus↵

ullamcorper metus ac suscipit. Cras suscipit rhoncus felis sed iaculis. Phasellus ornare tincidunt pulvinar. Aenean sit amet dictum arcu, eu rhoncus velit. Donec pulvinar magna a enim rhoncus rhoncus. Phasellus tempor maximus sagittis. Nullam dictum urna eros, sit amet cursus velit sagittis ut. In luctus eros tortor, a aliquam mauris rutrum vitae. Quisque egestas euismod tellus nec maximus.

Proin sed ex cursus↵

feugiat ipsum ut, sodales arcu. Curabitur sagittis, justo eget lobortis fringilla, lorem arcu vehicula enim, ut laoreet purus leo in mauris. Etiam ut elit a est viverra ultricies. Aliquam egestas lobortis metus vitae tempor. Suspendisse potenti. Ut scelerisque dolor ut est placerat mattis. Vivamus rutrum, mauris a facilisis consequat, nulla mauris rhoncus nisi, sit amet convallis arcu nisi at nisl.

Donec imperdiet↵

faucibus dui a venenatis. Morbi consequat elit ac vestibulum tempus. Aliquam eleifend porta leo, in accumsan nulla venenatis at. Curabitur eget felis lectus. Duis quis porta urna, a mollis ex. Quisque faucibus maximus volutpat. Donec volutpat lorem quis est dignissim malesuada. Cras ultricies leo metus, in accumsan lectus blandit porttitor. Vivamus hendrerit auctor odio non accumsan. Aliquam non augue sit amet est luctus mattis ut sit amet enim. Donec id orci luctus, consequat libero eget, mollis diam.

Integer pellentesque↵

tellus in libero gravida, sed maximus mi imperdiet. Duis sed volutpat purus, ut fringilla ex. Sed mollis risus sit amet dolor congue condimentum. Nullam porttitor quam ac ex vehicula, quis maximus turpis auctor. Nulla id rhoncus libero. Donec quis dolor ultrices, fringilla dui venenatis, tempor est. Etiam maximus justo eget dignissim gravida.

title: mkdocs hide: - navigation

Documentazione↵

Modello per la creazione di un progetto di documentazione online

Cosa è↵

Modello per la creazione di un progetto di documentazione online, creato con lo strumento MKDocs. Le pagine per inserire contenuti vengono redatte utilizzando il linguaggio MarkDown (.MD).

Lavoro realizzato con il prezioso supporto tecnico di @gbvitrano, @aborruso e #opendatasicilia a cui va un caro ringraziamento e un grande grazie per la pazienza.

Compilazione con Github pages↵

GitHub ghpages

https://uo-transizionedigitalecomunepalermo.github.io/mkdocs/

Strumenti integrati nel progetto↵

  • Addthis per la condivisione sui social, e stampa pagine del progetto. Loghi social visualizzabili nella parte destra della pagina web su desktop e in basso su dispsitivi mobile. IL codice di Addthis si inserisce nel file main.html che si trova al seguente percorso mkdocs-style/docs/overrides/main.html
  • Disqus per permettere di inserire commenti in ogni singola pagina, tranne nell'home page. L'istruzione per inserire il codice di Disqus viene data nel file mkdocs.yml
  • Strumento di generazione dei contenuti del progetto in formato PDF, indicato in ogni pagina con il simbolo della stampante posizionato in alto a destra
  • feed RSS per avere un link per gli aggiornamenti automatici dei contenuti del progetto di documentazione. L'istruzione per inserire l'integrazione dell feed RSS viene data nel file mkdocs.yml

Questi strumenti sono opzionali e possono non essere inclusi nella visualizzazione del progetto di documentazione online che si intende creare

Cosa deve cambiare l'utente per generare progetti di documentazione online con MKDocs a partire da questo modello↵

  • i parametri del file mkdocs.yml
  • i contenuti nel file index.md che si trova nella directory docs
  • i contenuti dei file .md che si trovano dentro la cartella madre docs (ed eventualmente sotto cartelle) e che rappresentano il nome dei capitoli o sezioni del documento. Ogni file .md è la pagine web del progetto di documentazione
  • inserire le immagini nella cartella img che si trova nel percorso mkdocs-style/docs/img/
  • inserire il favicon che si trova al seguente percorso mkdocs-style/docs/overrides/.icons/favicon.png. E' facoltativo e non è importante
  • inserire i dati nel file docs/manifest.webmanifest

Inserire servizio commenti Disqus↵

esempio di codice

<script id="dsq-count-scr" src="//guida-readthedocs.disqus.com/count.js" async></script>
<div id="disqus_thread"></div>
<script>
var disqus_config = function () {
this.page.url = PAGE_URL;  
this.page.identifier = PAGE_IDENTIFIER; 
};
(function() { 
var d = document, s = d.createElement('script');
s.src = 'https://guida-readthedocs.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>

Commenti

Back to top