Bring back mkdocs for documentation

Aperta
  • Qualcosa non va?
#46 0 commenti 0 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
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
julia
Ambito
documentation

Direzione di ricerca

L'issue non identifica file di documentazione, test o un punto di ingresso. Per prima cosa esamina l'attuale configurazione di Documenter e la configurazione della documentazione del repository, quindi determina le modifiche necessarie per una configurazione di mkdocs basata su Material; il lavoro sarà considerato completato quando il progetto avrà uno strumento di documentazione concordato e un sito generato funzionante.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

question

Documenter default output is niw html. Using mkdocs with material theme requires few extra steps. Do we want to do so?

Lingua principale
Julia
Stelle
19
Fork
9
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 JuliaHealth/BioMedQuery.jl

Tutte le issue di JuliaHealth/BioMedQuery.jl

Issue simili

Altre issue su Julia

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.