跳转至

Zensical 中文教程

最好的 Zensical 中文教程

  • 为什么选择 Zensical？

    Zensical Logo

    • MkDocs 已停止更新，Zensical 是官方推荐的新一代
    • 即时导航，无需刷新页面
    • 博客系统，开箱即用
    • 性能优异，加载迅速
    • 𝕙𝕒𝕧𝕖 𝕒 𝕘𝕠𝕠𝕕 𝕥𝕚𝕞𝕖 !

    请在上方标签选择分类/左侧目录选择文章

    请点击左上角图标选择分类和文章

不同于市面上过时的 MkDocs 教程，本站提供了 最详细、最便捷、最前沿 的 Zensical 中文教程，与 官方发布 的版本同步。包含了 Zensical 的安装、配置、主题美化、博客系统等内容。无论你是初学者还是有经验的用户，都能在这里找到你需要的帮助。𝓳𝓾𝓼𝓽 𝓮𝓷𝓳𝓸𝔂 𝓲𝓽～

📚 推荐学习路径

初学者路线

  1. 第一步：阅读 5 分钟快速开始
  2. 第二步：学习 zensical.toml 配置详解
  3. 第三步：掌握 博客系统完全指南
  4. 第四步：尝试 主题定制
  5. 第五步：部署到线上 GitHub Pages 部署

从 MkDocs 迁移

  1. 第一步：阅读 从 MkDocs 迁移到 Zensical
  2. 第二步：了解 配置文件差异
  3. 第三步：测试和调整
  4. 第四步：重新部署

高级用户路线

  1. 性能优化：阅读 性能优化指南
  2. SEO 优化：学习 SEO 优化
  3. 多语言支持：配置 多语言支持
  4. 自定义 404 页面：学习 自定义 404 页面
  5. 自定义字体：配置 自定义字体
  6. 添加评论系统：配置 评论系统
  7. 扩展开发：等待 Zensical 模块系统发布

🎯 核心特性

即时导航

Zensical 的即时导航功能让你的网站像单页应用一样流畅：

[project.theme]
features = [
    "navigation.instant",      # 即时导航
    "navigation.instant.prefetch",  # 预加载
]

重要

即时导航需要设置 site_url 才能正常工作：

[project]
site_url = "https://example.com"

博客系统

很快到来

Modern 主题

全新的 Modern 主题变体，更现代、更美观：

[project.theme]
variant = "modern"  # 或 "classic"

🚀 快速开始

# 创建虚拟环境
python3 -m venv .venv
source .venv/bin/activate  # macOS/Linux
# 或 .venv\Scripts\activate  # Windows

# 安装 Zensical
pip install zensical

# 创建新项目
zensical new .

# 启动开发服务器
zensical serve

打开浏览器访问 http://localhost:8000

详细步骤请阅读 5 分钟快速开始

📖 文档结构

Zensical-Chinese-Tutorial/
├── docs/
│   ├── index.md                    # 本页面
│   ├── about.md                    # 关于页面
│   ├── faq.md                      # 常见问题
│   ├── showcase.md                  # 案例展示
│   ├── getting-started/            # 快速开始
│   │   ├── quick-start.md          # 5 分钟快速开始
│   │   └── migration.md            # 从 MkDocs 迁移
│   ├── tutorials/                   # 核心教程
│   │   ├── blog-tutorial.md        # 博客系统完全指南
│   │   ├── configuration.md        # 配置详解
│   │   ├── theme-customization.md  # 主题定制
│   │   └── markdown-extensions.md  # Markdown 扩展
│   ├── blog/                       # 博客相关
│   │   ├── plugins/                # 插件文档
│   │   ├── deployment/             # 部署指南
│   │   └── advanced/              # 高级主题
├── zensical.toml                   # 配置文件
└── README.md                       # 项目说明

💡 实用技巧

提示

  • 使用 zensical serve 实时预览
  • 使用 zensical build --clean 清理构建
  • 查看 官方文档 获取最新信息

注意

Zensical 不支持 MkDocs hooks，请使用模板覆盖或 JavaScript 替代

信息

本教程持续更新，与 Zensical 官方版本同步

🌟 案例展示

🤝 参与贡献

欢迎参与 Zensical-Chinese-Tutorial 的完善：

  1. Fork 本仓库
  2. 创建你的特性分支
  3. 提交你的修改
  4. 推送到分支
  5. 创建 Pull Request

📞 联系方式

微信

Telegram

开始你的 Zensical 之旅吧！ 🚀
本站访问量：