ホーム>ASPソースコード>その他のカテゴリー
ダウンロード

SeaGL

これは、https://seagl.org で提供される Web サイトのソース コードです。

GitHub Pages で静的サイト ジェネレーターとして Jekyll を使用します。

コードが GitHub の共有リポジトリにプッシュされるたびに、サイトは自動的にレンダリングされます。

基本的に、サイトを更新する (新しいブログ投稿を公開するなど) 手順は次のとおりです。

  1. リポジトリをフォーク/クローンし、
  2. 変更を加えて、
  3. 変更をテストして、
  4. 変更のプル リクエスト (PR) を送信します。
  5. PR がマージされるとすぐに、変更がライブで公開されます

これらの各ステップの手順を以下に示します。この手順では、git/GitHub/技術的な経験が少ない人が作業を実行することを前提としています。より経験のある人は、それに応じて推定することができます。 :-)

リポジトリをフォーク/クローンする

おそらくこのリポジトリで直接作業することもできますが、ベスト プラクティスとしてはそうではないはずです。代わりに、リポジトリをフォークまたはクローンして、そのコピーに変更を加えることができます。これにより、変更を実際に適用する前にテストが可能になり、不適切な形式または言葉遣いの変更が世界に漏れ出るリスクが軽減されます。

リポジトリをフォークするには:

  1. ページの上部にあるフォークをクリックします。
  2. リポジトリのコピーの宛先アカウント/組織を選択します。
  3. すべてがコピーされるまで待ちます。

出来上がり！それだけです。

変更を加える

新しいブログ投稿を追加する場合は、次のファイル名のルールに従ってください。

  • すべてのブログ投稿を_postsディレクトリに配置します。
  • ファイル名はYYYY-MM-DD形式の日付で始まります。これは、Web サイトにブログ投稿が表示される順序を制御するため、非常に重要です。
    • 注意事項: Web サイトには、現在の日付までの投稿が表示されます。これにより、事前に投稿をスケジュールすることができますが、変更をテストするときに--future使用しない限り、将来の日付の投稿は表示されないことも意味します。現時点では、投稿を表示するには、予定日以降にサイトの再構築をトリガーする必要もあります。これは、 git commit -m 'rebuild pages' --allow-empty && git push origin mainを使用するか、サイトに実際の変更を加えることで実行できます。
  • 日付の後にダッシュ ( - ) を付け、ダッシュで区切った投稿のタイトルを続けます。このタイトルは表示されません。ファイルに名前を付けるだけです。簡潔に、しかし説明的なものにしてください。
  • 投稿が Markdown 形式で構成されていることを示すには、ファイル名拡張子.md使用します。 (マークダウンを使用して投稿のみを作成してください)

これらのルールにより、2017 CFP の開催を発表するブログ投稿のファイル名は次のようになります。 

 2017-06-19-CFP-open.md

ファイルの先頭に次の行も追加してください。 

 ---
layout: post
title: 'Example Title'
status: publish
type: post
published: true
categories: news
tags: '2013'
---

titleブログ投稿のタイトルに設定し、 tags編集して投稿に関連付けられているカンファレンス年を含めます (存在しない場合は空です)。残りの値はそのままにしてください。

実際のファイルの内容については、GitHub Web インターフェイスまたはローカル マシンで変更を加えることができます。

GitHub 上で

  1. 編集または追加するファイルがあるディレクトリ (おそらく_posts ) に移動します。
  2. 新しいファイルを作成するには:
    • Create a new file​​をクリックします
    • ファイルに名前を付けます（ブログ投稿の場合は上記の手順に従って）
  3. 変更を加える
    • 新しいファイルを作成するには:
      • Create a new file​​をクリックします
      • ファイル名を入力します（ブログ投稿の場合は上記の手順に従って）
    • 既存のファイルを編集するには:
      • ファイルをクリックして選択します
      • 小さな鉛筆アイコンをクリックします
    • いずれの方法でも、Web インターフェイスでファイルを編集できるようになります。
  4. 編集インターフェイスの下にあるCommit changesフォームを使用して、変更をコミットします。
    • 「2017 CFP 開始のお知らせの追加」など、短くてもわかりやすいタイトルを入力します。
    • 詳細な説明を入力します。問題に取り組んでいる場合は、ここで問題番号を参照してください。ハッシュマーク ( # ) に続けて問題番号 ( #74 ) を使用します。これはプルリクエストに自動的にリンクされるので、非常に便利です。

ローカルマシン上で

TBD (ローカルマシンで git を使用している人はすでにこれを知っていると仮定します。後で記入します)

  1. フォークのクローンを作成する
  2. 変更を加えます（ファイルの追加および/または編集）
  3. 変更をフォークにコミットして戻します

変更をテストする

GitHub にプッシュする前に、すべての変更をローカルでテストしてください。

ローカル開発サーバー

ローカル開発サーバーを起動すると、サイトのコピーが http://localhost:4000 で利用できるようになります。サーバーを実行するにはいくつかの方法があります。選んでください！

オプション 1: ベアメタル

依存関係:

  • ルビー
  • バンドラー

1 回限りのセットアップ: 

bundle install

サーバーを起動します。 

bundle exec jekyll serve --watch

将来の日付の未公開の投稿をプレビューするには、上記のコマンドに--future --unpublishedを追加します。

オプション 2: コンテナ化

依存関係:

  • Docker (または Podman。 docker podmanに置き換えます)

1 回限りのセットアップ: 

docker build --tag ' seagldev ' ' . '

サーバーを起動します。 

docker run --rm --interactive --tty --publish ' 4000:4000 ' --volume " $PWD :/usr/src/app " ' seagldev '

将来の日付の未公開の投稿をプレビューするには、上記のコマンドの最後に--future --unpublishedを追加します。

変更のプル リクエスト (PR) を送信します。

PR は、GitHub インターフェイスで送信することも、ローカル マシンから送信することもできます。

GitHub 上で

  1. ブラウザで、seagl.github.io リポジトリのフォークに移動します。
  2. Pull requestsタブをクリックします。
  3. New pull request buttonクリックします。
  4. GitHub はリポジトリがフォークであることを認識し、デフォルトでは PR がフォークのメイン ブランチとなり、seagl.github.io のメイン ブランチに対してリクエストを行うようになります。これはあなたが望むものである可能性が非常に高いです。そうでないとしても、あなたはこれを認識するのに十分な知識を持っているでしょう。 :-)
  5. Create pull requestをクリックします。
  6. 「2017 CFP 開始のお知らせの追加」など、短くてもわかりやすいタイトルを入力します。
  7. 詳細な説明を入力します。問題に取り組んでいる場合は、ここで問題番号を参照してください。ハッシュマーク ( # ) に続けて問題番号 ( #74 ) を使用します。これはプルリクエストに自動的にリンクされるので、非常に便利です。
  8. [Allow edits from maintainers](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)を選択します。 [Allow edits from maintainers](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) 、必要に応じて他のチーム メンバーが編集できるようにします。
  9. Create pull requestをクリックします。

ローカルマシン上で

TBD (ローカルマシンで git を使用している人はすでにこれを知っていると仮定します。後で記入します)

変更はライブで公開されます

次に、誰か (リポジトリへのそのレベルのアクセス権がある場合は、おそらくあなた) がプル リクエストをレビューしてマージする必要があります。

プル リクエストがマージされると、Web サイト上で公開されます。

注意: マージ自体はサイトの再構築をトリガーしません。サイトを再構築するには、次のように空のコミットをプッシュする必要があります。 

git commit --allow-empty -m " Rebuild the site, please " && git push

投稿に画像を追加する方法

画像をimg/posts/ディレクトリに追加し、次のマークダウンを使用します。 

 ![ Example description ] ( /img/posts/example.jpg )

ヒント:

  • 画像を横に揃えるには、 align-leftクラスまたはalign-rightクラスを追加します。 

     ![ Example description ] ( /img/posts/example.jpg ) {:.align-left}

  • ページの読み込み時間を短縮するため、投稿で画像を使用する前に画像を適切なサイズに変更してください。

過去のカンファレンスのアーカイブ

過去のカンファレンスは、Jekyll コレクションとして静的にアーカイブされます。

  • archive-conferences
  • archive-sessions

特定の年のアーカイブを作成するには、まずスケジュールからデータをインポートします。 

bundle exec rake import[2020]

- 修正が必要な場合は、アーカイブ ファイルを手動で編集します。

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて