Consider moving to MkDocs
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 13
- Fork
- 18
- Merge medio
- 2h 42m
- PR unite (30g)
- 5
Descrizione
Just an idea. Pros:
- Simpler stack, simpler config.
- Markdown has won. People don't know reST, even myself, after years of using it, still make the most basic mistakes and need to lookup the most basic stuff.
- Also supported by RTD.
- Has the Material theme, which is modern, under active development, flexible, has dark theme, etc.
- Is used at other projects, such as python.cz or junior.guru, so know-how would be shared (contributions, maintenance).
Cons:
- We extend Sphinx and would need to rewrite those things.
- We use reST extensively. I'm not sure we can port it 1:1 (but is it necessary?)
How:
- This can happen gradually. Our current setup supports Markdown, so texts can be converted first and we would see.
- I already moved from builtin Sphinx link check to Lychee, as it works better.
Guida per i contributori
Apri la guida per i contributori
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
Esamina la configurazione attuale di Sphinx e la documentazione esistente in Markdown e reST, quindi confronta le estensioni personalizzate con MkDocs e il relativo tema Material. Verifica la configurazione esistente di Lychee per il controllo dei link e la fattibilità di una conversione graduale a Markdown. L’issue non indica file né criteri di accettazione, quindi è ancora necessario concordare l’ambito della migrazione e la definizione di completamento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100