Caution
認証情報を載せないでください。本ドキュメントはリポジトリ、デプロイ先ともに公開されています。
-
以下のパッケージをインストールしてください。
-
Hugo v0.112.0以降をインストールしたことを確認してください。
hugo version
-
本リポジトリをcloneしてください
git clone git@github.com:omui-server/guidelines.git
-
本プロジェクトのディレクトリに移動してください
cd [Path to the project directory] -
Hugoの開発サーバーを起動してください
hugo server
Ctrl + Cを押すとサーバーが停止します。
コンテンツファイルは /content 以下に保存されています。
本ドキュメントは多言語対応しており、 /content/ja 以下は日本語、 /content/en は英語のコンテンツとなっています。
コンテンツはマークダウンで記述されており、新規のコンテンツを配置する場合は以下のように index.md を配置してください。
また、画像を配置したいときは index.md と同じディレクトリに img ディレクトリを作成し、その中に画像を配置してください。
[page id]はURL上のディレクトリ名を表します。
.
└── content
└── [lang]
└── docs
└── [section]
└── [page id]
├── img
└── index.md
main ブランチにコミットすると、GitHub Actionsが自動で https://omui-server.github.io/guidelines/ にデプロイします。