Usage Guide¶

Document Hosting の詳細な使用方法を説明します。

ドキュメントの作成¶

touch docs/new-page.md

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Usage: usage.md
  - New Page: new-page.md # 追加

# H1 見出し

## H2 見出し

### H3 見出し

- アイテム 1
- アイテム 2
  - サブアイテム

```python
def hello():
    print("Hello, World!")
```

[リンクテキスト](https://example.com)

![代替テキスト](images/example.png)

注意

これは注意事項です。

警告

重要な警告メッセージです。

ヒント

便利なヒントです。

def calculate_sum(a: int, b: int) -> int:
    """2つの数値の合計を計算します。"""
    return a + b

result = calculate_sum(5, 3)
print(f"Result: {result}")

function greet(name) {
  console.log(`Hello, ${name}!`);
}

greet('World');

mkdocs build

これにより site/ フォルダに静的 HTML ファイルが生成されます。

詳細は README.md を参照してください。

Q: ページが表示されない
A: mkdocs.yml の nav セクションにページが追加されているか確認してください。

Q: 画像が表示されない
A: 画像パスが正しいか、docs/ フォルダ内に画像があるか確認してください。

Q: スタイルが適用されない
A: mkdocs serve を再起動してみてください。

The MkDocs configuration is stored in mkdocs.yml. You can customize:

To deploy the documentation to GitHub Pages, run:

mkdocs gh-deploy

This will build the documentation and push it to the gh-pages branch.

The project uses the Material theme. You can customize the theme by modifying the theme section in mkdocs.yml:

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo

See the Material for MkDocs documentation for more customization options.