SuperAPI AI 工具集

zensical

写作与研究

查看项目

更新于 10-16 01:17

技能介绍

用途:Zensical 是面向项目文档的现代静态站点生成器,由 Material for MkDocs 的作者打造,用于创建、配置和发布文档站点。

主要能力:使用 TOML 配置(zensical.toml),并支持 mkdocs.yml 用于迁移;提供 modern 与 classic 两种主题变体;支持自动或显式导航、即时导航、目录、面包屑、标签、搜索、分析、Cookie 同意、离线使用、自定义 CSS/JavaScript、模板覆盖、Markdown 扩展、mkdocstrings API 文档与评论系统集成;内置 Lucide、Material Design、FontAwesome、Octicons、Simple Icons 等图标集。

使用方式:安装可执行 python3 -m venv .venv && source .venv/bin/activate && pip install zensical,或用 uv init && uv add --dev zensical;创建项目 zensical new .;预览 zensical serve;构建 zensical build。配置写在 zensical.toml 的 [project] 作用域下,如 site_name、site_url、theme、nav、markdown_extensions 等。部署支持 GitHub Pages(GitHub Actions)与 GitLab Pages(GitLab Pages 需设置 site_dir = "public")。

适用场景:需要为开源项目或产品编写结构化文档站点,并希望从 MkDocs/Material for MkDocs 平滑迁移的团队。

限制:搜索目前仅支持英文;离线模式需禁用即时导航、分析、仓库信息与评论;navigation.prune 与 navigation.expand 不兼容,navigation.indexes 与 toc.integrate 不兼容;即时预览为实验性功能,仅支持 headerlinks。具体收费、价格与平台支持范围资料暂未提供。