👨‍💻 niltor    📆 2026-09-02 16:48

内容结构

默认内容目录如下:

Content/
├── about.md
├── blogs/
├── custom/
├── docs/
│   └── EasyDocs/
│       ├── en-US/2.0/
│       └── zh-CN/2.0/
└── products/
    └── MyProduct/
        ├── logo.svg
        ├── en-US/
        └── zh-CN/

博客

Content/blogs 下的每个 Markdown 文件都会生成博客页面,子目录会成为博客分类。图片和其他静态文件会复制到对应的输出路径。

技术文档

文档路径格式为 docs/<name>/<language>/<version>/...,其中名称、语言和版本必须在 DocInfos 中声明。例如:

Content/docs/EasyDocs/zh-CN/2.0/快速开始.md

会生成:

WebSite/docs/EasyDocs/zh-CN/2.0/快速开始.html

可以使用 .order 文件控制 Markdown 文件和目录的混排顺序,条目不包含 .md 后缀:

介绍
快速开始
高级主题
常见问题

相对 Markdown 链接会将 .md 转换为 .html,绝对 HTTP(S) 链接保持不变。custom 下的文件最后复制,可以覆盖内置 CSS、JavaScript、模板或生成页面。

Markdown 中使用图片

图片不要求必须放在名为 images 的目录中。EasyDocs 会按照 Markdown 文件所在位置解析本地图片的相对路径,因此图片可以与文档放在同一目录,也可以放在任意子目录中:

Content/docs/EasyDocs/zh-CN/2.0/
├── 快速开始.md
├── logo.svg
└── assets/
    └── architecture.png
![Logo](logo.svg)
![架构图](assets/architecture.png)

博客和文档构建时会复制对应内容目录下的 .jpg、.jpeg、.png、.gif 和 .svg 图片。请使用相对于 Markdown 文件的正确路径,并建议使用小写扩展名。远程 http:// 和 https:// 图片地址会直接保留,不会复制到输出目录。

版本化文档页支持正确的相对图片路径。不过,生成的文档入口页 docs/<文档名>.html 使用该文档的第一篇内容,当前构建器只会改写以 ./_images 开头的入口页图片路径。如果图片还需要在文档入口页显示,请使用以下约定:

Content/docs/EasyDocs/zh-CN/2.0/
├── 快速开始.md
└── _images/
    └── architecture.png
![架构图](./_images/architecture.png)