[mkdocs] - rebuild docs automatically on update

Aperta
#7,644 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
build-system, documentation

Direzione di ricerca

Inizia sul branch live-docs esaminando come vengono attualmente utilizzati make examples e mkdocs serve. Traccia il flusso di ricostruzione della documentazione e confrontalo con il comportamento di Jekyll descritto; il lavoro è completato quando le modifiche agli esempi o al testo appaiono nel browser senza dover arrestare, ricostruire e riavviare manualmente il server.

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

Descrizione

One of the benefits of our current docs for contributors if you are working on a doc and make some change to an example or some text, jekyll rebuilds the documentation automatically and you can see the change in your browser.

With how mkdocs is implemented on the live-docs branch you need to stop the mkdocs server, rebuild the docs using make examples and then restart the server (mkdocs serve)

Lingua principale
JavaScript
Stelle
18.3k
Fork
2k
Merge medio
2g 12h
PR unite (30g)
28

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 plotly/plotly.js

Tutte le issue di plotly/plotly.js

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.