Minimal は、GitHub Pages の Jekyll テーマです。テーマをプレビューしてどのように見えるかを確認したり、すぐに使用したりすることもできます。
Minimal テーマを使用するには:
サイトの_config.yml
に以下を追加します。
remote_theme : pages-themes/[email protected]
plugins :
- jekyll-remote-theme # add this line to the plugins list if you already have one
必要に応じて、コンピュータ上でサイトをプレビューしたい場合は、サイトのGemfile
に以下を追加します。
gem "github-pages" , group : :jekyll_plugins
Minimal は、サイトの_config.yml
に設定されている場合、次の変数を尊重します。
title : [The title of your site]
description : [A short description of your site's purpose]
さらに、次のオプションの変数を設定することもできます。
show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]
独自のカスタム スタイルを追加したい場合:
/assets/css/style.scss
というファイルを作成します。---
---
@import " {{ site.theme }} " ;
@import
行の直後に必要なカスタム CSS (またはインポートを含む Sass) を追加します。注: テーマの Sass 変数を変更したい場合は、スタイルシートの@import
行の前に新しい値を設定する必要があります。
テーマの HTML レイアウトを変更したい場合:
favicon
などの一部の変更については、ローカルの_includes
フォルダーにカスタム ファイルを追加できます。テーマに付属のファイルは開始点を提供し、元のレイアウト テンプレートに含まれています。/_layouts/default.html
というファイルを作成します。Google は、このテーマが最初に作成されて以来、長年にわたって Google Analytics コードの反復を数回リリースしてきました。最新のコードを利用したい場合は、Jekyll サイトの_includes/head-custom-google-analytics.html
に貼り付けてください。
テンプレートは多くの場合、リポジトリへのリンクやプロジェクトをダウンロードするためのリンクなど、GitHub によって提供される URL に依存します。 1 つ以上のデフォルト URL をオーバーライドする場合は、次のようにします。
{{ site.github.zip_url }}
の形式になります。_config.yml
でテンプレートに使用する URL を指定します。たとえば、変数がsite.github.url
の場合は、次を追加します。 github :
zip_url : http://example.com/download.zip
another_url : another value
注: site.
プレフィックスを付け、各変数名 ( github.
の後) はgithub:
の下にスペース 2 つでインデントする必要があります。
詳細については、Jekyll 変数のドキュメントを参照してください。
提案された機能 (および既知の問題) のリストについては、未解決の問題を参照してください。
Minimal テーマは、GitHub Pages ユーザーが最初 (または 100 番目) の Web サイトを迅速かつ簡単に作成できるようにすることを目的としています。テーマは、柔軟性よりもシンプルさの面で、すぐに大多数のユーザーのニーズを満たし、特定のニーズがある場合、またはエクスペリエンスをさらにカスタマイズしたい場合に、ユーザーがさらに複雑になるようにオプトインする機会を提供する必要があります。 (カスタム CSS の追加やデフォルトのレイアウトの変更など)。見た目も良くなければなりませんが、それは言うまでもありません。
Minimal に貢献することに興味がありますか?ぜひご協力をお願いいたします。 Minimal はオープンソース プロジェクトであり、あなたのようなユーザーによって一度に 1 つずつ貢献して構築されます。貢献方法については、CONTRIBUTING ファイルを参照してください。
テーマをローカルでプレビューしたい場合 (たとえば、変更を提案する過程で):
git clone https://github.com/pages-themes/minimal
)cd
テーマのディレクトリに移動しますscript/bootstrap
を実行して必要な依存関係をインストールします。bundle exec jekyll serve
実行してプレビュー サーバーを起動しますlocalhost:4000
にアクセスしてテーマをプレビューしますテーマには、そのテーマを含むサイトが正常に構築されることを確認するための最小限のテスト スイートが含まれています。テストを実行するには、 script/cibuild
実行するだけです。テスト スクリプトが機能する前に、 script/bootstrap
を 1 回実行する必要があります。