はじめてのZensical

markdownで作成したドキュメントをhtml形式でビルドするZensicalの構築および実装方法について記載します。

Getting started

cf. https://zensical.org/docs/get-started/

前提

Pythonが必要なのでインストールしておいてください。
Zensicalをインストールします:

pip install zensical

Zensicalプロジェクトを作成します:

zensical new .

ローカルでドキュメント閲覧サーバを http://localhost:8000/ で起動します:

zensical serve

設定

サンプル

[project]
site_name = "Nob docs"
copyright = """
Copyright &copy; nob
"""

[project.extra]
generator = false

[project.theme]
features = [
    "content.code.copy"
]
variant = "classic"

[[project.theme.palette]]
scheme = "default"
toggle.icon = "lucide/moon"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "black"
accent = "deep purple"
toggle.icon = "lucide/sun"
toggle.name = "Switch to light mode"

[project.markdown_extensions.pymdownx.highlight]
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions.pymdownx.magiclink]