ai folioダウンロード - ai folioソースコードのダウンロード

ai folio

その他のソースコード

1.0.0

ダウンロード

アルフォリオ

シンプル、クリーン、応答性の高い学者向けの Jekyll テーマ。テーマが気に入ったら、スターを付けてください。

ユーザーコミュニティ
Lighthouse PageSpeed の洞察
目次
はじめる
- インストール
  - Docker を使用したローカルセットアップ (推奨)
  - ローカルセットアップ (レガシー)
  - 導入
  - 以前のバージョンからのアップグレード
- よくある質問
特徴
- 出版物
- コレクション
- レイアウト
  - 蒸留所の象徴的なスタイル
  - 数学とコードを完全にサポート
  - 写真
- その他の機能
  - GitHub のリポジトリとユーザー統計
  - テーマ設定
  - ソーシャルメディアのプレビュー
  - Atom (RSS のような) フィード
  - 関連記事
貢献する
- メンテナー
- すべての貢献者
ライセンス

はじめる

ジキルについてもっと知りたいですか?このチュートリアルを確認してください。なぜジキルなのか？ Andrej Karpathy のブログ投稿を読んでください。

インストール

al-folio インストールの実践的なウォークスルーについては、コミュニティメンバーの 1 人によるこのクールなビデオチュートリアルをご覧ください。 ? ?

このテンプレートを使用する場合は、ファイルリストの上にある [このテンプレートを使用する] をクリックすることをお勧めします。次に、 github.com:<your-username>/<your-repo-name>に新しいリポジトリを作成します。サイトを<your-github-username>.github.ioにアップロードする場合は、リポジトリの名前が<your-github-username>.github.ioまたは<your-github-orgname>.github.ioである必要があることに注意してください。 <your-github-orgname>.github.io 、GitHub ページのドキュメントに記載されているとおり。サイトを展開する方法の詳細については、以下の「展開」セクションを確認してください。新しいリポジトリを作成したら、それをマシンにダウンロードするだけです。

$ git clone [email protected]: < your-username > / < your-repo-name > .git
$ cd < your-repo-name >

Docker を使用したローカルセットアップ (推奨)

Docker を使用して Jekyll と Ruby の依存関係をインストールするのが最も簡単な方法です。

al-folioローカルマシン上で起動して実行するには、次の手順を実行する必要があります。

まず、docker と docker-compose をインストールします。
最後に、次のコマンドを実行すると、最新のビルド済みイメージが DockerHub からプルされ、Web サイトが実行されます。

$ docker compose pull
$ docker compose up

初めて実行すると、サイズ 400MB 程度の Docker イメージがダウンロードされることに注意してください。

ここで、テーマを自由にカスタマイズしてください (名前を変更することを忘れないでください)。完了したら、同じコマンド ( docker compose up ) を使用して、すべての変更を加えた Web ページをレンダリングできます。また、最終的な変更は必ずコミットしてください。

ポート番号を変更するには、 docker-compose.ymlファイルを編集します。

(クリックして展開)独自の Docker イメージを構築します。

注: このアプローチは、al-folio の古いバージョンまたは非常にカスタムなバージョンを構築したい場合にのみ必要です。

以下を使用して、新しい Docker イメージを構築して実行します。

$ docker compose up --build

jekyll を更新したり、新しい Ruby パッケージをインストールしたりしたい場合は、前のコマンドの最後に--force-recreate引数を使用してイメージを再度ビルドするだけです。 Ruby と Jekyll をダウンロードし、すべての Ruby パッケージを最初から再度インストールします。

特定の Docker バージョンを使用したい場合は、 docker-compose.yamlのlatestタグをyour_versionに変更することで使用できます。たとえば、 v0.10.0で Web サイトを作成しており、それを使い続けたいと考えているとします。

ベータ版 docker image タグをスリムに変更することもできます。これは、サイズが 100 MB 未満のスリム化された Docker イメージです (同じ機能)。

ローカルセットアップ (レガシー)

システムに Ruby と Bundler (ヒント: Ruby gem の管理を容易にするために、 rbenv の使用を検討してください)、さらに Python と pip (ヒント: Python パッケージの管理を容易にするために、venv や conda などの仮想環境の使用を検討してください) がシステムにインストールされていると仮定します。 jupyterのみを使用する場合は、 pipx を使用できます。

$ bundle install
# assuming pip is your Python package manager
$ pip install jupyter
$ bundle exec jekyll serve --lsi

ここで、テーマを自由にカスタマイズしてください (名前を変更することを忘れないでください)。完了したら、最後の変更をコミットします。

導入

Web サイトを GitHub Pages にデプロイするのが最も一般的なオプションです。バージョン v0.3.5 以降、 al-folio は新しい変更をリポジトリにプッシュするたびに Web ページを自動的に再デプロイします。

個人および組織の Web ページの場合:

リポジトリの名前は、 <your-github-username>.github.ioまたは<your-github-orgname>.github.ioでなければなりません。
_config.ymlで、 url https://<your-github-username>.github.ioに設定し、 baseurl空のままにします。
Web ページの自動展開を設定します (以下の手順を参照)。
変更を加え、コミットし、プッシュしてください。
デプロイ後、Web ページは<your-github-username>.github.ioで利用できるようになります。

プロジェクトページの場合:

_config.ymlで、 urlをhttps://<your-github-username>.github.ioに、 baseurl /<your-repository-name>/に設定します。
Web ページの自動展開を設定します (以下の手順を参照)。
変更を加え、コミットし、プッシュしてください。
デプロイ後、Web ページは<your-github-username>.github.io/<your-repository-name>/で利用できるようになります。

自動展開を有効にするには:

「アクション」タブをクリックし、 「GitHub アクションを有効にする」をクリックします。すべてがすでに設定されているため、ワークフローの作成について心配する必要はありません。
[設定] -> [アクション] -> [全般] -> [ワークフロー] 権限に移動し、GitHub アクションに読み取りおよび書き込み権限を付与します。
Web ページにその他の変更を加え、コミットしてプッシュします。これにより、 Deployアクションが自動的にトリガーされます。
数分間待って、アクションが完了するまで待ちます。 [アクション]タブで進行状況を確認できます。正常に完了すると、 masterブランチに加えて、リポジトリに新しく構築されたgh-pagesブランチが追加されるはずです。
最後に、リポジトリの設定の [ページ] セクションで、ブランチをgh-pagesに設定します ( masterではありません)。詳細については、「GitHub Pages サイトの公開ソースの構成」を参照してください。

サイトを別のブランチに保持する場合は、 Web サイトを保持するブランチで.github/workflows/deploy.ymlを開き、on->push->branches および on->pull_request->branch を Web サイトを保持するブランチに変更します。の上。これにより、そのブランチのプル/プッシュのアクションがトリガーされます。このアクションは、トリガーされたブランチに Web サイトをデプロイします。

(クリックして展開) GitHub ページへの手動デプロイメント:

Web サイトを GitHub ページに手動で再デプロイする必要がある場合は、「アクション」に移動し、左側のサイドバーにある「デプロイ」をクリックして、「ワークフローを実行」をクリックします。

(クリックして展開)別のホスティングサーバー (GitHub ページ以外) へのデプロイメント:

GitHub Pages を使用せず、別の場所でページをホストすることにした場合は、次のコマンドを実行するだけです。

$ bundle exec jekyll build --lsi

これにより、静的 Web ページが_site/フォルダーに (再) 生成されます。次に、 _site/ディレクトリの内容をホスティングサーバーにコピーするだけです。

ファイルから未使用の CSS クラスも削除したい場合は、次を実行します。

$ purgecss -c purgecss.config.js

これにより、 _site/assets/css/フォルダー内の CSS ファイルが、パージされた CSS ファイルに置き換えられます。

注: Web ページを構築する前に、 _config.ymlのurlとbaseurlフィールドを必ず正しく設定してください。 Web ページをyour-domain.com/your-project/にデプロイする場合は、 url: your-domain.comおよびbaseurl: /your-project/設定する必要があります。 your-domain.comに直接デプロイする場合は、 baseurl空白のままにしておきます。

(クリックして展開)別のリポジトリへのデプロイメント (上級ユーザーのみ):

注:何をしようとしているのかわからない場合は、この方法を使用しないでください (ソースの発行に精通していることを確認してください)。このアプローチにより、Web サイトのソースコードを 1 つのリポジトリに置き、展開バージョンを別のリポジトリに置くことができます。

Web サイトの公開ソースが$HOME/repo/の下に複製された git バージョン管理リポジトリのpublishing-sourceサブディレクトリであると仮定します。ユーザーサイトの場合、これは$HOME/<user>.github.ioのようなものになる可能性があります。

まず、デプロイメントリポジトリディレクトリから、公開ソースをホストしている git ブランチをチェックアウトします。

次に、Web サイトのソースディレクトリ (通常は al-folio フォークのクローン) から次のようにします。

$ bundle exec jekyll build --lsi --destination $HOME /repo/publishing-source

これにより、jekyll に Web サイトを$HOME/repo/publishing-sourceにデプロイするように指示されます。

注: Jekyll はビルドする前に$HOME/repo/publishing-sourceクリーンアップします。

以下の引用は、jekyll 設定ドキュメントから直接引用したものです。

宛先フォルダーはサイトのビルド時にクリーンアップされます
<destination>のコンテンツは、デフォルトでは、サイトの構築時に自動的にクリーンアップされます。サイトによって作成されていないファイルまたはフォルダーは削除されます。一部のファイルは、 <keep_files>構成ディレクティブ内で指定することで保持できます。
<destination>には重要な場所を使用しないでください。代わりに、それをステージング領域として使用し、そこから Web サーバーにファイルをコピーします。

$HOME/repo/publishing-source jekyll にそのままにしておきたいファイルが含まれている場合は、 _config.ymlのkeep_filesの下にそれらのファイルを指定します。デフォルト設定では、al-folio はトップレベルのREADME.md発行元にコピーします。この動作を変更したい場合は、 _config.ymlのexcludeの下にREADME.mdを追加します。

注:公開ソースリポジトリでjekyll cleanを実行しないでください。実行すると、 _config.ymlのkeep_filesの内容に関係なく、ディレクトリ全体が削除されます。

以前のバージョンからのアップグレード

上記のようにal-folioをインストールした場合は、リポジトリをテーマの最新バージョンと自動的に同期するように GitHub アクションを構成できます。

[設定] -> [アクション] -> [一般] -> [ワークフロー] 権限に移動し、GitHub Actions に読み取りおよび書き込み権限を付与し、「GitHub Actions にプルリクエストの作成と承認を許可する」にチェックを入れて、変更を保存します。

次に、「アクション」->「新しいワークフロー」->「ワークフローを自分で設定」に移動し、次のワークフローを設定して変更をコミットします。

 name : Sync from template
on :
    # cronjob trigger
  schedule :
  - cron :  " 0 0 1 * * "
  # manual trigger
  workflow_dispatch :
jobs :
  repo-sync :
    runs-on : ubuntu-latest
    steps :
      # To use this repository's private action, you must check out the repository
      - name : Checkout
        uses : actions/checkout@v3
      - name : actions-template-sync
        uses : AndreasAugustin/[email protected]
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          source_repo_path : alshedivat/al-folio
          upstream_branch : master

テンプレートに利用可能な変更がある場合は、リポジトリ内でプルリクエストを受け取ります。

もう 1 つのオプションは、以下の手順に従ってコードを手動で更新することです。

 # Assuming the current directory is <your-repo-name>
$ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream
$ git rebase v0.9.0

以前のバージョンを大幅にカスタマイズした場合は、アップグレードが難しくなる可能性があります。上記の手順に従うこともできますが、 git rebaseによりマージ競合が発生する可能性があり、解決する必要があります。詳細については、git rebase マニュアルと競合の解決方法を参照してください。リベースが複雑すぎる場合は、新しいバージョンのテーマを最初から再インストールし、コンテンツと以前のバージョンからの変更を手動で移植することをお勧めします。

よくある質問

よくある質問をいくつか紹介します。別の質問がある場合は、ディスカッションを使用して質問してください。

Q:このテンプレートから新しいリポジトリを作成し、リポジトリをセットアップした後、デプロイメントエラーが発生します。 Web サイトは自動的に正しく展開されるはずではありませんか?
A:はい、リリースv0.3.5以降を使用している場合、Web サイトは最初のコミット直後に自動的かつ正しく再デプロイされます。いくつかの変更を加え (例: _config.ymlの Web サイト情報を変更)、コミットして、プッシュしてください。前のセクションの展開手順に従ってください。（該当号：209号）
Q:カスタムドメイン (例: foo.com ) を使用しています。デプロイのたびに、カスタムドメインがリポジトリ設定で空白になります。それを修正するにはどうすればよいですか?
A: CNAMEファイルをリポジトリのmasterまたはsourceブランチに追加する必要があります。ファイルにはカスタムドメイン名が含まれている必要があります。（関連号：130）
Q:私の Web ページはローカルで動作します。しかし、デプロイ後はビルドに失敗し、 Unknown tag 'toc'がスローされます。それを修正するにはどうすればよいですか?
A:前のセクションの展開手順に従っていることを確認してください。デプロイメントブランチをgh-pagesに設定する必要があります。 (関連号: 1438)
Q:私の Web ページはローカルで動作します。しかし、デプロイ後は正しく表示されません（CSSとJSが正しく読み込まれていません）。それを修正するにはどうすればよいですか?
A: _config.ymlでurlとbaseurlパスを正しく指定していることを確認してください。 urlをhttps://<your-github-username>.github.ioに設定するか、カスタムドメインを使用している場合はhttps://<your.custom.domain>に設定します。個人または組織の Web サイトを展開している場合は、 baseurl空白のままにしておきます。プロジェクトページをデプロイしている場合は、 baseurl: /<your-project-name>/を設定します。これまでの手順がすべて正しく行われた場合、必要なのはブラウザーがサイトスタイルシートを再度取得することだけです。
Q: Atom フィードが機能しません。なぜ？
A: _config.ymlでurlとbaseurlパスを正しく指定していることを確認してください。 RSS フィードプラグインは、正しく設定されたフィールド ( title 、 url 、 description 、 authorで動作します。適切な方法で入力して、もう一度お試しください。
Q: related_blog_posts有効にするとサイトが機能しません。なぜ？
A:これはおそらく、関連投稿の計算に使用される分類子リボーンプラグインが原因です。エラーにLiquid Exception: Zero vectors can not be normalized...と表示されている場合は、特定の投稿の関連投稿を計算できなかったことを意味します。これは通常、意味のある単語 (ストップワードのみ) や投稿内で使用した特定の文字が含まれていない空のブログ投稿または最小限のブログ投稿によって発生します。また、同様の投稿の計算は、すべてのpostに対して行われます。これは、お知らせを含む、 layout: post使用するすべてのページを意味します。この動作を変更するには、関連投稿を表示したくないページの前題に、 related_posts: falseを追加するだけです。
Q:デプロイしようとすると、github のログイン資格情報が要求されますが、github はパスワード認証を無効にし、エラーで終了します。修正方法は?
A:好みのエディターを使用して .git/config ファイルを開きます。 url変数のhttps部分をsshに変更します。もう一度デプロイしてみてください。

特徴

出版物

出版物のページは、BibTex 参考文献から自動的に生成されます。 _bibliography/papers.bibを編集するだけです。 _pages/publications.mdを編集することで、新しい*.bibファイルを追加し、出版物の外観を自由にカスタマイズすることもできます。

(クリックして展開)著者の注釈:

出版物では、自分自身の著者エントリは、 _config.ymlの文字列配列scholar:last_nameと文字列配列scholar:first_nameによって識別されます。

 scholar :
  last_name : [Einstein]
  first_name : [Albert, A.]

エントリが姓と名のいずれかの形式に一致する場合、下線が付きます。共著者に関するメタ情報を_data/coauthors.ymlに保存しておくと、Jekyll がその Web ページへのリンクを自動的に挿入します。 _data/coauthors.ymlの共著者データ形式は次のとおりです。

 " Adams " :
  - firstname : ["Edwin", "E.", "E. P.", "Edwin Plimpton"]
    url : https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams

" Podolsky " :
  - firstname : ["Boris", "B.", "B. Y.", "Boris Yakovlevich"]
    url : https://en.wikipedia.org/wiki/Boris_Podolsky

" Rosen " :
  - firstname : ["Nathan", "N."]
    url : https://en.wikipedia.org/wiki/Nathan_Rosen

" Bach " :
  - firstname : ["Johann Sebastian", "J. S."]
    url : https://en.wikipedia.org/wiki/Johann_Sebastian_Bach

  - firstname : ["Carl Philipp Emanuel", "C. P. E."]
    url : https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach

エントリが姓と名の組み合わせのいずれかに一致する場合、そのエントリが強調表示され、指定された URL にリンクされます。

(クリックして展開)ボタン (カスタム bibtex キーワードによる):

Web ページ上でのエントリの表示方法に影響を与えるために使用できるカスタム bibtex キーワードがいくつかあります。

abbr : エントリの左側に略語を追加します。これらへのリンクを追加するには、_data フォルダーに会場.yaml ファイルを作成し、一致するエントリを追加します。
abstract : クリックすると非表示のテキストフィールドを展開して要約テキストを表示する「Abs」ボタンを追加します。
arxiv : Arxiv Web サイトへのリンクを追加します (注: ここには arxiv 識別子のみを追加します - リンクは自動的に生成されます)
bibtex_show : 完全な参考文献エントリを含む非表示のテキストフィールドを展開する「参考文献」ボタンを追加します。
html : ユーザー指定のリンクにリダイレクトする「HTML」ボタンを挿入します。
pdf : 指定したファイルにリダイレクトする「PDF」ボタンを追加します (完全なリンクが指定されていない場合、ファイルは /assets/pdf/ ディレクトリに配置されると想定されます)
supp : 指定されたファイルに「Supp」ボタンを追加します (完全なリンクが指定されていない場合、ファイルは /assets/pdf/ ディレクトリに配置されると想定されます)
blog : 指定されたリンクにリダイレクトする「ブログ」ボタンを追加します。
code : 指定したリンクにリダイレクトする「コード」ボタンを追加します。
poster : 指定されたファイルにリダイレクトする「ポスター」ボタンを追加します (完全なリンクが指定されていない場合、ファイルは /assets/pdf/ ディレクトリに配置されると想定されます)
slides : 指定したファイルにリダイレクトする「スライド」ボタンを追加します (完全なリンクが指定されていない場合、ファイルは /assets/pdf/ ディレクトリに配置されると想定されます)
website : 指定したリンクにリダイレクトする「Webサイト」ボタンを追加します。
altmetric : Altmetric バッジを追加します (注: DOI が提供されている場合はtrue使用し、それ以外の場合は Altmetric 識別子のみをここに追加します - リンクは自動的に生成されます)
dimensions : ディメンションバッジを追加します (注: DOI または PMID が指定されている場合はtrue使用し、それ以外の場合はディメンションの識別子のみをここに追加します。リンクは自動的に生成されます)

bib.html ファイルを編集することで、独自のボタンを実装できます。

コレクション

この Jekyll テーマは、作品をカテゴリに分類できるcollections実装しています。テーマには、 newsとprojects 2 つのデフォルトのコレクションが付属しています。 newsコレクションの項目が自動的にホームページに表示されます。 projectsコレクションのアイテムは、プロジェクトページの応答性の高いグリッドに表示されます。

独自のコレクション、アプリ、短編小説、コースなど、あらゆるクリエイティブな作品を簡単に作成できます。これを行うには、 _config.ymlファイル内のコレクションを編集し、対応するフォルダーを作成し、 _pages/projects.mdのようなコレクションのランディングページを作成します。

レイアウト

al-folio には、ページやブログ投稿用のスタイリッシュなレイアウトが付属しています。

蒸留所の象徴的なスタイル

このテーマを使用すると、distill.pub スタイルでブログ投稿を作成できます。

<d-*>タグを使用して蒸留スタイルの投稿を作成する方法の詳細については、例を参照してください。

数学とコードを完全にサポート

al-folio は、 MathJax による高速な数式組版と、GitHub スタイルを使用したコード構文のハイライトをサポートしています。

写真

Bootstrap のグリッドシステムを使用すると、写真の書式設定が簡単になります。ブログ投稿やプロジェクトページ内に美しいグリッドを簡単に作成できます。

その他の機能

GitHub のリポジトリとユーザー統計

al-folio は、 github-readme-stats と github-profile-trophy を使用して、GitHub リポジトリとユーザー統計を/repositories/ページに表示します。

_data/repositories.ymlを編集し、 github_usersとgithub_reposリストを変更して、独自の GitHub プロファイルとリポジトリを/repositories/ページに含めます。

次のコードを使用して、これを他のページに表示することもできます。

 <!-- code for GitHub users -->
{% if site.data.repositories.github_users %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
  {% for user in site.data.repositories.github_users %}
    {% include repository/repo_user.html username=user %}
  {% endfor %}
</ div >
{% endif %}

<!-- code for GitHub trophies -->
{% if site.repo_trophies.enabled %}
{% for user in site.data.repositories.github_users %}
  {% if site.data.repositories.github_users.size > 1 %}
  < h4 > {{ user }} </ h4 >
  {% endif %}
  < div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
  {% include repository/repo_trophies.html username=user %}
  </ div >
{% endfor %}
{% endif %}

<!-- code for GitHub repositories -->
{% if site.data.repositories.github_repos %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
  {% for repo in site.data.repositories.github_repos %}
    {% include repository/repo.html repository=repo %}
  {% endfor %}
</ div >
{% endif %}

テーマ設定

さまざまな美しいテーマカラーが選択できるように選択されています。デフォルトは紫ですが、 _sass/_themes.scssファイルの--global-theme-color変数を編集することですぐに変更できます。他の色の変数もそこにリストされています。利用可能なストックテーマカラーオプションは、 _sass/_variables.scssにあります。このファイルに独自の色を追加し、テンプレート全体で使いやすいようにそれぞれに名前を割り当てることもできます。

ソーシャルメディアのプレビュー

al-folio はソーシャルメディアでのプレビュー画像をサポートします。この機能を有効にするには、 _config.ymlでserve_og_meta trueに設定する必要があります。これを完了すると、サイトのすべてのページの HTML head 要素に Open Graph データが含まれるようになります。

次に、サイトのソーシャルメディアプレビューに表示する画像を構成する必要があります。これは、 og_imageページ変数を設定することで、ページごとに構成できます。個々のページでこの変数が設定されていない場合、テーマは_config.ymlで構成可能なサイト全体のog_image変数に戻ります。ページ固有の場合とサイト全体の場合の両方で、 og_image変数には、ソーシャルメディアのプレビューに表示する画像の URL を保持する必要があります。

Atom (RSS のような) フィード

投稿の Atom (RSS のような) フィードを生成します。これは、Atom および RSS リーダーに役立ちます。ホームページの/feed.xmlの後に入力するだけで、フィードにアクセスできます。たとえば、Web サイトのマウントポイントがメインフォルダーであると仮定すると、 yourusername.github.io/feed.xmlと入力できます。

貢献する

al-folio への投稿は大歓迎です。始める前に、ガイドラインをご覧ください。

ドキュメントを改善したい場合、以下のリストに Web ページを追加したい場合、または軽微な不一致やバグを修正したい場合は、お気軽にmasterに直接 PR を送信してください。より複雑な問題/バグ、または機能リクエストについては、適切なテンプレートを使用して問題を開いてください。

メンテナー

私たちの最も積極的な貢献者は、メンテナチームに参加することを歓迎します。ご興味がございましたら、ぜひご連絡ください。

_マルアン

_{ローハン・デブ・サーカール}

_{アミール・プールマン}

_ジョージ

すべての貢献者

contrib.rocks で作成されました。

ライセンス

このテーマは、MIT ライセンスの条件に基づいてオープンソースとして利用できます。

もともと、 al-folio は*folio テーマ (Lia Bogoev によって MIT ライセンスの下で公開) に基づいていました。それ以来、スタイルが完全に書き直され、多くの優れた機能が追加されました。

拡大する

追加情報

バージョン 1.0.0
タイプその他のソースコード
更新時間 2024-11-28
サイズ 12.39MB
から Github

ai folio