Anduin2017 / Anduin2017/HowToCook
目录混乱 + 中文目录
Nessuno ha ancora preso questa issue.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 102k
- Fork
- 11.1k
- Merge medio
- 14h 21m
- PR unite (30g)
- 2
Descrizione
mkdocs scan folder生成的HTML index基本上是乱的
可以利用https://www.mkdocs.org/user-guide/writing-your-docs/
来customize navigation bar
比方说:
nav:
- README.md
- 菜谱: dishes/
- 做菜技巧: tips/
- CONTRIBUTING.md
Idea:
- Contributions放在最下面
- 中文目录 (dishes -> 菜谱)
但是现在mkdocs nav section并不支持folder https://github.com/mkdocs/mkdocs/issues/714
可以写个脚本每次自动生成nav:这个section,或者直接把文件夹名字改成中文
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Leggi la guida di MkDocs sulla scrittura della documentazione e ispeziona la configurazione attuale della navigazione insieme alle cartelle dishes/ e tips/. Confronta gli approcci disponibili per ordinare i contributi per ultimi e presentare etichette in cinese; il lavoro è completato quando l’indice HTML generato contiene la navigazione prevista senza alterare la documentazione esistente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown, yaml
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100