欢迎使用 MDW
MDW 是一个类 Markdown 文档建站框架,目标是让文档即网站。支持:- 📝 类 Markdown 语法(
.mdw/.md文件) - 📂 自动路由——文档目录层级就是 URL 结构,嵌套无上限
- 🧭 元数据驱动导航——用
nav/parent/order等字段定制侧边栏 - 🎨 自定义样式——可配置识别字符,可引入外部 CSS / HTML
- 📱 响应式侧边栏——移动端抽屉式导航,可整体收起
- 🔌 自定义扩展(Parser / Renderer / Middleware)
- 🔄 热重载——保存文件即刷新页面
- ⚙️ 管理员后台 ——
/admin
快速开始
- 在
docs/目录下创建.mdw文件 - 运行
python app.py - 打开 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 模板(不会注册为路由)
文档头部可用
--- 包裹的元数据定制导航与页面信息,详见
元数据参考。