S3 Simiki3

Python 3 · Markdown · Static sites

Documentation that stays close to your source.

Simiki3 turns Markdown and YAML front matter into a fast, portable static wiki with themes, feeds, attachments, and a simple local preview workflow.

Read in English 阅读中文文档
Get started 
simiki3 init my-wiki
simiki3 build my-wiki
simiki3 serve my-wiki --watch

Build locally. Publish anywhere.

Pages

en

  • Deployment — Publish a Simiki3 site with GitHub Pages or another static host.
  • Development — Run the Simiki3 development workflow and test suite.
  • English documentation — Start using Simiki3 to build a Markdown-powered static wiki.

en/about

  • Roadmap — Current Simiki3 milestones and project direction.

en/getting-started

  • Installation — Install Simiki3 and prepare a local development environment.
  • Quick start — Create, build, and preview a Simiki3 site in a few commands.

en/guides

  • Migration — Audit and migrate a legacy Simiki site to Simiki3.
  • Themes — Select, synchronize, and customize a Simiki3 theme.

en/reference

  • CLI reference — Reference for the Simiki3 command-line interface.
  • Configuration — Configure site metadata, paths, URL prefixes, and themes.

zh

  • 中文文档 — 使用 Simiki3 构建由 Markdown 驱动的静态 Wiki。
  • 开发 — 运行 Simiki3 开发流程和测试套件。
  • 部署 — 使用 GitHub Pages 或其他静态托管服务发布 Simiki3 站点。

zh/about

  • 路线图 — Simiki3 当前里程碑和项目方向。

zh/getting-started

  • 安装 — 安装 Simiki3 并准备本地开发环境。
  • 快速开始 — 用几个命令创建、构建并预览 Simiki3 站点。

zh/guides

  • 主题 — 选择、同步并自定义 Simiki3 主题。
  • 迁移 — 审计旧版 Simiki 站点并迁移到 Simiki3。

zh/reference

  • CLI 参考 — Simiki3 命令行界面的完整参考。
  • 配置 — 配置站点元数据、路径、URL 前缀和主题。