https://cgtf.github.io/user-guidance/
- Hugoのインストール
- git submoduleのアップデート
- npmパッケージのインストール
git clone [email protected]:cgtf/user-guidance.git
Hugo(静的サイトジェネレーター)を利用しています。開発にはHugoが必要です。インストールはこちらをご確認ください。
npm install
npm scriptsによって以下が実行されます。
git submodule update --init --recursive
- HugoのテーマにDocsyを利用しています。gitのサブモジュールになっています。
(cd themes/docsy && npm install)
- docsyの依存解決
ローカル環境で動作確認するには、下記コマンドを実行してからhttp://localhost:1313/にアクセスします。LiveReloadにより、コードに変更を加えて保存するとブラウザに反映されます。
hugo server
※ --buildFuture
, --buildDrafts
, --buildExpired
を付けて実行すると、公開日付が未来の記事、下書きの記事、公開期限切れの記事も表示されます。
サーバーに配置して公開するためのHTMLファイルを生成するには、下記コマンドを実行します。ファイルは public
フォルダに生成されます。
hugo
※ --buildFuture
, --buildDrafts
, --buildExpired
を付けて実行すると、公開日付が未来の記事、下書きの記事、公開期限切れの記事も生成されます。