Add gh-pages based docs
オープン
- 主要言語
- Python
- スター
- 203
- フォーク
- 39
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
README.md grew large so it would be useful to structure the docs in a gh-pages based site.
We can use: [jekyll](https://jekyllrb.com/), [mkdocs](https://www.mkdocs.org/) or [hugo](https://gohugo.io/documentation/) as doc site generator
コントリビューションガイド
調査の方向性
README.mdから始め、既存のドキュメントをgh-pagesベースのサイトとして構成するために、提案されているJekyll、MkDocs、Hugoの選択肢を比較します。サイトジェネレーターが選択され、単一のREADMEを超えてドキュメントが整理され、gh-pagesを通じて利用可能になれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- hugo, jekyll
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100