godot website
1.0.0
Godot Engine Webサイトのソースコードへようこそ。これは静的なWebサイトで、Jekyllを使用してオフラインで生成されます。
貢献はいつでも大歓迎です！ GodotのWebサイトは、Godotエンジンと同じようにオープンソースです。
ただし、Webサイトに貢献する場合、Godotの組織とコミュニティの公的な顔として機能することを留意することが重要です。したがって、実質的な変更について事前に議論する必要があります。エンジンの機能を使用するように、必ずしも正式なGodot改善提案を開く必要はありませんが、このリポジトリで問題を開始したり、Godot Contributors Chatのディスカッションに参加することは良い考えです。
新機能に取り組むときは、このウェブサイトは常緑ブラウザーのみをサポートしていることに留意してください。
インターネットエクスプローラーはサポートされていません。
ウェブサイトをローカルに構築するには、次の手順に従ってください。
rbenvを使用してRubyの特定のバージョンを使用する必要があります。sudo apt install rubenvrbenvをインストールしますecho 'eval "$(rbenv init -)"' >> ~/.bashrcを実行して、rbenv initを.bashrc （または.bash_profile ）に追加しますrbenvをセットアップします。rbenv install 3.1.2rbenv global 3.1.2minifyが利用可能であることを確認してください。bundle install 。bundle exec jekyll build 。--config _config.yml,_config.development.ymlは、ビルドで開発構成を使用します。簡単にするために、これら2つのコマンドは、このリポジトリのbuild.shスクリプトとしても利用できます。
または、Jekyllに公式のDockerコンテナを使用することもできます。このコンテナは、ビルドを実行するために1回実行するように設計されているため、Dockerセットアップに作成して永久に保存する必要はありません。 Linuxを使用している場合は、次のコマンドを実行します。
docker run --rm --volume= " $PWD :/srv/jekyll " -it jekyll/jekyll:stable ./build.sh Windows（ CMD.exeから）：
docker run --rm --volume= " %CD%:/srv/jekyll " -it jekyll/jekyll:stable ./build.sh建物には数分かかる場合があります。
これは静的なWebサイトであるため、必要なサーバースタックを使用して地元で提供できます。
bundleを使用して、すぐにページを構築するとすぐに提供することができます。これを行うには、最終的なビルドステップをbundle exec jekyll serveに置き換えます。 Dockerを使用する場合、 docker runコマンド-p 4000:4000に新しい引数を追加し、シェルスクリプトを変更してbuild-and-serve.shに変更する必要があります。
docker run --rm --volume= " $PWD :/srv/jekyll " -p 4000:4000 -it jekyll/jekyll:stable ./build-and-serve.shまたは
docker run --rm --volume= " %CD%:/srv/jekyll " -p 4000:4000 -it jekyll/jekyll:stable ./build-and-serve.shpython -m http.server 4000 -d ./_siteを実行します。これらのステップのいずれかに従った後、サイトはhttp://localhost:4000で利用可能になります。
プロジェクトは、 masterブランチが新しいコミットを受け取るたびに、GitHubアクションによって自動的に構築されます。 masterブランチ自体は、ソースファイルのみが含まれているため、展開しないでください。ビルドバージョンのWebサイトは、代わりにpublishedブランチとして入手できます。
これは現地開発には関係ありません。ローカルでは、Webサイトを所定の位置に構築し、 _siteフォルダーを提供します。上記の詳細な指示を参照してください。
次のフォルダーには、ブログ、ショーケース、ダウンロードページなど、ウェブサイトのより動的な部分を生成するために使用されるデータファイルが含まれています。これらのページはマークダウンで記述されており、ジェネレーターが使用するメタデータヘッダーが含まれています。 Markdownファイルは、コンテンディングフォルダーと同じ名前のJekyllコレクションを形成します。新しいMarkdownドキュメントを作成するには、既存のドキュメントをコピーしてコンテンツを変更することから始めます。
collections/_articleには、ブログの記事が含まれています。各記事は、ファイルの上部にあるメタデータヘッダーを使用してマークダウンで書かれています。ウェブサイト全体に記事を正しく表示するには、次のメタデータフィールドが必要です： title 、 excerpt 、 categories 、 author 、 image 、 date 。ファイルの名前は、生成されたURLのナメクジとして機能します。
collections/_downloadには、プラットフォームごとにGodotビルドのダウンロード手順が含まれています。各ドキュメントは、ファイルの上部にあるメタデータヘッダーを使用してマークダウンで記述されています。ダウンロードリンクは、メタデータのdownloadsフィールドから生成されます。新しいプラットフォームを追加するときは、 /_layouts/download.html download.htmlテンプレートに新しいタブを作成してください。
collections/_showcaseには、ショーケースのエントリが含まれています。各記事は、ファイルの上部にあるメタデータヘッダーを使用してマークダウンで書かれています。 showcaseエントリは、 featured_in_homeフィールドをtrueに設定することにより、ホームページで紹介できます。使用される画像は、 imageフィールドからの画像です。
一部の情報はYAMLファイルにも保存され、いくつかのメタプロパティのファイルベースのデータベースとして機能します。
_dataは、Webサイトのさまざまなメタデータファイルが含まれています。authors.ymlには、ブログ記事に使用される著者のリストが含まれています。categories.ymlには、ブログ記事のカテゴリのリストが含まれています。communities.ymlには/community/user-groupsページのユーザーコミュニティのリストが含まれています。次のフォルダーには、ほぼすべてのWebサイトページのエントリポイント、および共有テンプレートとアセットが含まれています。 Jekyllで使用されるテンプレート言語は液体です。
_i18nには、Webサイトの翻訳が含まれています。デフォルトの言語は英語です。ブログとショーケースは英語で表示されているため、静的な情報のみが翻訳されています。現在障害者であり、進行中の作業。
_includesは、ほとんどのページで使用されるナビゲーションとフッター要素が含まれています。複数のページで再利用する要素を作成する場合は、ここから新しいインクルードファイルを作成できます。
_layoutsは、ページのラッピングコンテンツが含まれています。各レイアウトは、 _layouts/default.htmlから継承されます。_layouts/default.htmlには、ヘッドタグやメタタグを含むページのメイン構造が含まれています。他のレイアウトは、ブログ、ダウンロード、ショーケースページなどの特定のページに使用されます。
assets 、ウェブサイトの静的資産が含まれています。これには、テーマとレイアウトで使用されるCSS、JS、および画像が含まれます。記事やその他のページで使用されるメディアコンテンツについては、 storageフォルダーを確認してください。一部のファイルは時代遅れで使用されていない場合があります。
pagesには、Webサイトのほとんどのページが含まれています。各ページの最終URLは、 permalinkフィールドを使用してメタデータヘッダーで指定されています。通常、 pages内のファイルのパスにマッピングする必要があります。動的コンテンツページは、Markdownコレクションとレイアウトを使用して生成されます。
storageは、ブログ、ショーケース、イベントなどの動的なコンテンツページで使用するためにアップロードされるメディアやその他のファイルが含まれています。一部のファイルは時代遅れで使用されていない場合があります。このプロジェクトは、Jekyllで構築され、 Gemfileと_config.ymlにあるビルド指示があります。ローカルに構築する場合、一部の構成オプションは異なる必要がある場合があります。それらを定義するために、 _config.development.ymlが使用されます。
Webサイト上のすべてのダウンロード情報はデータ駆動型です。これは、現在の安定したバージョン、または進行中のバージョンのプレビューに関する情報を変更するには、ページを直接変更する必要がないことを意味します。代わりに、データファイルを更新する必要があります。
すべての公式バージョンを追跡するためのメインファイルはdata/_versions.ymlです。プリリースを含む、公式リリースごとに1つのレコードが正確に1つ含まれています。このファイルは、ダウンロードできる新しい公式ビルドがあるたびに更新する必要があります。
新しいバージョンを作成するには、次のブロックをファイルに追加します。
- name: "4.0.1"
flavor: "stable"
release_date: "20 March 2023"
release_notes: "/article/maintenance-release-godot-4-0-1/"
より高いバージョン番号が上部に近い場合、エントリを正しく注文してください。 flavorフィールドを使用して、リリースを安定している、またはプレリリースビルドの1つとしてマークします。利用可能な場合は、必ずリリース日とリリースノートリンクを記入してください。
既存のバージョンの新しいビルドが公開されたら、対応するブロックを更新し、フレーバーとリリース情報を変更します。リリースノートを公開するときは、必ずこの情報を更新してください。
ウェブサイト全体に掲載された安定したリリースは、 featuredフィールドと対応するメジャーバージョン番号でマークする必要があります。バージョンごとに紹介されているようにマークする必要があるレコードは1つだけなので、マークの現在の所有者から削除することを忘れないでください。
- name: "4.0.3"
flavor: "stable"
release_date: "19 May 2023"
release_notes: "/article/maintenance-release-godot-4-0-3/"
featured: "4"
ダウンロードページとリンクのデータを提供する2つの追加ファイルがあります： _data/download_configs.ymlおよび_data/download_platforms.yml 。これらのファイルは通常、変更を必要とせず、静的リファレンステーブルとして使用されます。それらは、すべてのダウンロード可能なビルドの説明、タグ、およびファイル名のスラグを定義し、一部のページでダウンロードの注文を定義します。
新しいホストをミラーリストでサポートする必要がある場合は、いくつかの場所に追加する必要があります。 _data/mirrorlist_configs.ymlを更新する必要があるもののデータ側の場合、メジャーバージョンコードの別のレコードを追加します。
- name: "4.1"
stable: [ "github", "tuxfamily" ]
preview: [ "github_builds", "tuxfamily" ]
stableキーは、そのバージョンの安定したリリースで利用可能なホストを指しますが、 previewキーはすべてのリリースと開発スナップショットを指し、通常はすべての特性を共有します。将来、より細かい制御が必要な場合、いくつかのオーバーライドシステムを実装する必要があります。
物事の論理面については、新しいホストを_plugins/make_download.rbスクリプトでサポートする必要があります。そのファイルで他のホストがどのように処理されるかを参照し、必要な調整を行います。最終的なファイル名はすべてのホストにわたって標準であるため、 _data/download_configs.ymlが尊重されると想定しています。
