広島Unity勉強会の公式サイト(hiro-uni.github.io)のリポジトリです。Astroを使用して構築されています。
本プロジェクトの編集内容をローカル環境で確認する手順です。
Node.js(LTS推奨)がインストールされていることを確認してください。
- macOS: Homebrewを使用して
brew install nodeを実行してください。 - Windows: パッケージマネージャーを使用して
winget install OpenJS.NodeJSを実行してください。
ターミナルでリポジトリのルートディレクトリに移動し、依存関係をインストールします。
npm install以下のコマンドを実行して、ローカルサーバーを起動します。
npm run devコマンド実行後、ターミナルに表示されるURL(通常は http://localhost:4321/)をブラウザで開くと、現在のサイトの状態を確認できます。ファイルを編集すると、ブラウザが自動的に更新されます。
新しいニュースやお知らせを追加するには、src/content/news/ ディレクトリにMarkdown(.md)ファイルを追加します。
-
ファイルの作成
src/content/news/内に新しいファイルを作成します。
ファイル名は2024-01-14-title.mdのように、日付から始めることを推奨します。 -
メタデータの記述 (Frontmatter) ファイルの先頭に、以下のように記事の情報をハイフン3つ(
---)で囲んで記述します。--- title: "記事のタイトル" pubDate: 2024-01-14 description: "記事の概要(一覧ページ等で表示されます)" ---
-
本文の記述 メタデータの下に、Markdown形式で本文を自由に記述してください。
-
デプロイ(公開) 作成したファイルをGitHubのメインブランチ(
main)にプッシュ(またはGitHub上で追加)すると、自動的にGitHub Actionsが実行され、数分以内に公式サイトへ反映されます。
主要なディレクトリ構成は以下の通りです。
/
├── src/
│ ├── content/
│ │ └── news/ <-- ニュースのMarkdownファイル
│ ├── assets/ <-- 画像などのアセット
│ ├── layouts/ <-- 共通レイアウト
│ └── pages/ <-- ページファイル (.astro)
├── public/ <-- 公開ファイル
└── package.json <-- スクリプト定義
本プロジェクトのライセンスについては、LICENSE.md を参照してください。