just the docs
v0.10.0
高度にカスタマイズ可能で応答性に優れた、組み込みの検索機能を備えたドキュメント用の最新の Jekyll テーマ。
依存関係がほとんどなく、GitHub Pages で簡単にホストできます。
実際に見てみましょう！
Just the Docs のさまざまな機能のビデオウォークスルー
Just the Docs テンプレートは、Just the Docs テーマを使用する新しい Web サイトを作成するための最もシンプル、迅速、簡単な方法を提供します。サイトの作成を始めるには、「テンプレートを使用する」をクリックするだけです。
注: テーマを使用するには、Just the Docs リポジトリを複製したりフォークしたりする必要はありません。これは、テーマのドキュメントをローカルで参照する場合、テーマの開発に貢献する場合、または Just the Docs に基づいて新しいテーマを開発する場合にのみ行う必要があります。
テンプレートによって作成されたサイトを GitHub Pages で公開するように簡単に設定できます。テンプレートの README ファイルにはその方法やその他の詳細が説明されています。
Jekyll がコンピュータにインストールされている場合は、作成したサイトをローカルに構築してプレビューすることもできます。これにより、変更をコミットする前にテストできるようになり、GitHub Pages を待つ必要がなくなります。 1また、ローカル ビルドを GitHub Pages とは異なるプラットフォームにデプロイできるようになります。
具体的には、作成されたサイトは次のとおりです。
Gemfileを使用し、 just-the-docs gem をロードします。それ以外は、テンプレートを使用して作成したサイトを自由にカスタマイズできます。 just-the-docsと使用する Jekyll のバージョンを簡単に変更したり、プラグインを追加したりできます。
あるいは、新しいサイトを作成せずに、テーマを Ruby Gem としてインストールすることもできます。
次の行を Jekyll サイトのGemfileに追加します。
gem "just-the-docs"そして、次の行を Jekyll サイトの_config.ymlに追加します。
theme : just-the-docsそして、以下を実行します。
$ bundle
または、次のように自分でインストールします。
$ gem install just-the-docs
あるいは、サイトの開発中に Docker 内で実行することもできます。
$ docker-compose up
使用方法についてはドキュメントを参照してください。
バグレポート、新機能の提案、プルリクエストは、GitHub (https://github.com/just-the-docs/just-the-docs) で受け付けています。このプロジェクトは、安全で居心地の良いコラボレーションの場となることを目的としており、貢献者は貢献者規約の行動規範を遵守することが期待されます。
このテーマを開発するための環境をセットアップするには、このリポジトリをフォークし、ルート ディレクトリからbundle install実行します。
VSCode の最新の devcontainer 構成が含まれています。
テーマは通常の Jekyll サイトと同じように設定されています。テーマをテストするには、 bundle exec jekyll serveを実行し、 http://localhost:4000でブラウザを開きます。これにより、テーマを使用して Jekyll サーバーが起動します。通常どおりページ、ドキュメント、データなどを追加して、テーマのコンテンツをテストします。テーマやコンテンツに変更を加えると、サイトが再生成され、通常と同じように、更新後にブラウザに変更が表示されるはずです。
このテーマがリリースされると、Git で追跡された_layouts 、 _includes 、および_sass内のファイルのみが gem に含まれます。
このテーマは、MIT ライセンスの条件に基づいてオープン ソースとして利用できます。
サイトへの変更を GitHub にプッシュした後、その変更が公開されるまでに最大 10 分かかる場合があります。 ↩
