这是什么

最后更新于： 2026年9月14日 / EpoCanvas 官方工程与架构规范

EpoCanvas Docs 是 EpoCanvas 项目的官方文档项目。用直白的话讲：这个仓库交付的就是”说明文档”本身——你现在正在浏览的整个网站，就是它的成品。仓库里没有其他软件的功能代码，你要找的”产品”，就是这个文档站点。

“文档项目”是什么意思

这个词有两层含义，同时成立：

它是一份说明书。 内容围绕”是什么、怎么用、怎么改、怎么上线”展开：阅读界面怎么操作、新文档怎么撰写、配置改哪里、部署命令是什么。写它只有一个目的——让拿到 EpoCanvas 的人不用到处问人，照着文档就能把事情做成。
它本身也是一个能直接运行的网站系统。 把仓库 clone 到本地，执行 pnpm install 和 pnpm run dev 两条命令，就能得到和你眼前一模一样的站点。整套代码基于 Astro 5 与 Starlight，采用 MIT 协议，可以整体搬走，改成你自己项目的文档站。

还有一个容易忽略的特点：这份文档介绍的每个功能，你此刻都在亲身使用。三栏阅读布局、Ctrl + K 全站检索、右上角 10 种语言就地切换——文档里讲的就是这个站点自己实现的能力，边读边试即可验证。

按读者身份划分，这个文档项目承担三件事：

一句话概括：让使用者看得懂，让开发者拿得走，让撰写者有章可循。

侧边栏共分五组，各自回答一个问题：

每篇文章都是独立可查的，不必按顺序通读。

误会一：“这是某个软件的说明书，我要去找那个软件本身。” 这个仓库里只有文档站点的源码，没有其他软件的代码；文档实际讲解的对象，就是这套文档站点系统自己的使用、定制与部署。

误会二：“这是只读网站，下载下来也没什么用。” 正相反，源码在 GitHub 上完全开放，本地两条命令即可运行；把它当作模板改成自己项目的文档站，正是它设计好的用途之一。