Add gh-pages based docs
Aperta
- Lingua principale
- Python
- Stelle
- 203
- Fork
- 39
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
README.md grew large so it would be useful to structure the docs in a gh-pages based site.
We can use: [jekyll](https://jekyllrb.com/), [mkdocs](https://www.mkdocs.org/) or [hugo](https://gohugo.io/documentation/) as doc site generator
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con README.md, quindi confronta le opzioni proposte Jekyll, MkDocs e Hugo per strutturare la documentazione esistente come sito basato su gh-pages. Il lavoro è completato quando è stato selezionato un generatore di siti, la documentazione è organizzata oltre il singolo README ed è disponibile tramite gh-pages.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- hugo, jekyll
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100