Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Consider moving to MkDocs

Aperta
#434 11 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
markdown
Ambito
documentation

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.

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.
Lingua principale
Python
Stelle
13
Fork
18
Merge medio
2h 15m
PR unite (30g)
6

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pyvec/docs.pyvec.org

Tutte le issue di pyvec/docs.pyvec.org

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.