[mkdocs] - rebuild docs automatically on update
オープン
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 18.3k
- フォーク
- 2k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 28
説明
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)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
live-docs ブランチで、現在 make examples と mkdocs serve がどのように使われているかを確認することから始めます。ドキュメントの再ビルドフローを追跡し、説明されている Jekyll の動作と比較します。完了の条件は、サーバーを手動で停止、再ビルド、再起動しなくても、サンプルやテキストの変更がブラウザーに表示されることです。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- build-system, documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100