Update Japanese Contributing doc

This commit is contained in:
0xhotchocolate
2023-01-10 22:45:57 +02:00
parent 3869ae4288
commit 3ca26cc7c4

View File

@@ -65,6 +65,27 @@ dactyl_link_checker
dactyl_style_checker
```
### 日本語サイトのビルド
ターゲットと出力先を指定してビルドしてください。
```
dactyl_build -t ja -o out/ja
```
日本語サイトの場合、生成されたコンテンツをウェブブラウザーでファイルとして開くことができません。ローカルHTTPサーバーやエディターの拡張機能(VSCodeであればLive Serverなど)を利用してください。
##### ローカルでHTTPサーバを利用する方法
1. `out`直下で次のコマンドを実施しサーバーを起動する
```
python -m http.server
```
2. ウェブブラウザーから`localhost`にアクセスする。
サーバー起動時にアサインされたポート番号を利用してください。
## 設定の書式
このリポジトリー内のテンプレートは`dactyl-config.yml`ファイルのメタデータを使用して、生成されたサイトをナビゲートする際のページ階層を生成します。ナビゲーションを正しく生成するには、ページの定義に適切なフィールドを含める必要があります。以下の例に、すべてのフィールドを指定したページを示します。