快速上手
特性
- 基于 dumi 约定式 markdown 路由
- 只需要编写 markdown 即可生成文档站点！
- 提供 demo 分离部署接入
谁在使用？
安装
- 创建 dumi 应用
yarn create @umijs/dumi-app
- 安装 Tuya 主题
yarn add @tuya/dumi-theme-tuya
- 配置多语言标识符
import { defineConfig, IConfig } from 'dumi';export default defineConfig({// ...省略其他配置// 多语言标识符（推荐使用 zh、en）locales: [['zh', '中文'],['en', 'English'],],} as IConfig);
- 在 docs 目录下编写 markdown，示例目录结构：
docs├── config # 顶部导航 - 配置│ ├── README.en.md│ └── README.md├── docs # 顶部导航 - 文档│ ├── exports # 文档 - 侧边菜单 - 内置组件│ │ ├── add-404.en.md│ │ └── add-404.md│ ├── getting-started # 文档 - 侧边菜单 - 介绍│ │ ├── README.en.md│ │ ├── README.md│ │ ├── how-works.en.md│ │ └── how-works.md│ └── usage # 文档 - 侧边菜单 - 基础使用│ ├── front-matter.en.md│ └── front-matter.md├── index.en.md # 首页 en└── index.md # 首页 zh
- 启动调试～
yarn start
- 打包部署
yarn build
然后将dist目录拿去部署就好了