首页

欢迎使用 MDW

MDW 是一个类 Markdown 文档建站框架,目标是让文档即网站。支持:

快速开始

  1. docs/ 目录下创建 .mdw 文件
  2. 运行 python app.py
  3. 打开 http://127.0.0.1:8080

目录结构示例

TEXT
docs/ ├── index.mdw → / (首页) ├── about.mdw → /about ├── quickstart.mdw → /quickstart (parent: /guide,挂在“使用指南”下) ├── guide/ │ ├── index.mdw → /guide/ (分组节点) │ ├── metadata.mdw → /guide/metadata │ ├── styles.mdw → /guide/styles │ ├── advanced/ │ │ ├── index.mdw → /guide/advanced/ │ │ └── deep.mdw → /guide/advanced/deep │ └── examples/ → 无 index,自动生成目录列表页 └── _styles/ → 外部 CSS / HTML 模板(不会注册为路由)
文档头部可用 --- 包裹的元数据定制导航与页面信息,详见 元数据参考