docs: dir rfc according to doc site routes (umijs#61)

* docs: dir rfc according to doc site routes * docs: extract concepts to multiple single files
xierenyuan · Feb 18, 2020 · cbb3e9e · cbb3e9e
1 parent d6d0ccb
commit cbb3e9e
Show file tree

Hide file tree

Showing 47 changed files with 219 additions and 0 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -0,0 +1,3 @@
+---
+title: Config
+---
diff --git a/docs/config/index.zh-CN.md b/docs/config/index.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: Config
+---
diff --git a/docs/docs/advanced.md b/docs/docs/advanced.md
@@ -0,0 +1,13 @@
+---
+title: umi 进阶
+---
+
+## 自定义 webpack 配置
+
+## 自定义 babel 配置
+
+## 按需加载
+
+## Test
+
+## TypeScript
diff --git a/docs/docs/advanced.zh-CN.md b/docs/docs/advanced.zh-CN.md
@@ -0,0 +1,13 @@
+---
+title: umi 进阶
+---
+
+## 自定义 webpack 配置
+
+## 自定义 babel 配置
+
+## 按需加载
+
+## Test
+
+## TypeScript
diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -0,0 +1,3 @@
+---
+title: API 索引
+---
diff --git a/docs/docs/api.zh-CN.md b/docs/docs/api.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: API 索引
+---
diff --git a/docs/docs/concepts/app-structure.md b/docs/docs/concepts/app-structure.md
@@ -0,0 +1,5 @@
+---
+title: 目录结构
+nav:
+  title: Umi 基础
+---
diff --git a/docs/docs/concepts/app-structure.zh-CN.md b/docs/docs/concepts/app-structure.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 目录结构
+---
diff --git a/docs/docs/concepts/config.md b/docs/docs/concepts/config.md
@@ -0,0 +1,3 @@
+---
+title: 配置
+---
diff --git a/docs/docs/concepts/config.zh-CN.md b/docs/docs/concepts/config.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 配置
+---
diff --git a/docs/docs/concepts/env-variables.md b/docs/docs/concepts/env-variables.md
@@ -0,0 +1,3 @@
+---
+title: 环境变量
+---
diff --git a/docs/docs/concepts/env-variables.zh-CN.md b/docs/docs/concepts/env-variables.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 环境变量
+---
diff --git a/docs/docs/concepts/html-template.md b/docs/docs/concepts/html-template.md
@@ -0,0 +1,3 @@
+---
+title: HTML 模板
+---
diff --git a/docs/docs/concepts/html-template.zh-CN.md b/docs/docs/concepts/html-template.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: HTML 模板
+---
diff --git a/docs/docs/concepts/mock-data.md b/docs/docs/concepts/mock-data.md
@@ -0,0 +1,3 @@
+---
+title: 数据 Mock
+---
diff --git a/docs/docs/concepts/mock-data.zh-CN.md b/docs/docs/concepts/mock-data.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 数据 Mock
+---
diff --git a/docs/docs/concepts/navigate-between-pages.md b/docs/docs/concepts/navigate-between-pages.md
@@ -0,0 +1,3 @@
+---
+title: 页面跳转
+---
diff --git a/docs/docs/concepts/navigate-between-pages.zh-CN.md b/docs/docs/concepts/navigate-between-pages.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 页面跳转
+---
diff --git a/docs/docs/concepts/page.md b/docs/docs/concepts/page.md
@@ -0,0 +1,3 @@
+---
+title: 页面
+---
diff --git a/docs/docs/concepts/page.zh-CN.md b/docs/docs/concepts/page.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 页面
+---
diff --git a/docs/docs/concepts/plugin.md b/docs/docs/concepts/plugin.md
diff --git a/docs/docs/concepts/plugin.zh-CN.md b/docs/docs/concepts/plugin.zh-CN.md
diff --git a/docs/docs/concepts/router.md b/docs/docs/concepts/router.md
@@ -0,0 +1,3 @@
+---
+title: 路由
+---
diff --git a/docs/docs/concepts/router.zh-CN.md b/docs/docs/concepts/router.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 路由
+---
diff --git a/docs/docs/concepts/runtime-config.md b/docs/docs/concepts/runtime-config.md
@@ -0,0 +1,3 @@
+---
+title: 运行时配置
+---
diff --git a/docs/docs/concepts/runtime-config.zh-CN.md b/docs/docs/concepts/runtime-config.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 运行时配置
+---
diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -0,0 +1,7 @@
+---
+title: 贡献
+---
+
+## 如何贡献
+
+## 如何创建 umi 插件
diff --git a/docs/docs/contributing.zh-CN.md b/docs/docs/contributing.zh-CN.md
@@ -0,0 +1,7 @@
+---
+title: 贡献
+---
+
+## 如何贡献
+
+## 如何创建 umi 插件
diff --git a/docs/docs/faq.md b/docs/docs/faq.md
@@ -0,0 +1,3 @@
+---
+title: FAQ
+---
diff --git a/docs/docs/faq.zh-CN.md b/docs/docs/faq.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: FAQ
+---
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -0,0 +1,12 @@
+<!-- 此目录为 /docs 下的所有子路由 -->
+---
+title: 介绍
+---
+
+## 介绍
+
+## 快速上手
+
+## umi 如何工作
+
+## 部署
diff --git a/docs/docs/index.zh-CN.md b/docs/docs/index.zh-CN.md
@@ -0,0 +1,11 @@
+---
+title: 介绍
+---
+
+## 介绍
+
+## 快速上手
+
+## umi 如何工作
+
+## 部署
diff --git a/docs/docs/styles-assets.md b/docs/docs/styles-assets.md
@@ -0,0 +1,13 @@
+---
+title: 样式和资源文件
+---
+
+## 使用 CSS
+
+## 添加自定义字体
+
+## 添加额外的脚本
+
+## 添加 SVG Icons
+
+## 使用图片
diff --git a/docs/docs/styles-assets.zh-CN.md b/docs/docs/styles-assets.zh-CN.md
@@ -0,0 +1,13 @@
+---
+title: 样式和资源文件
+---
+
+## 使用 CSS
+
+## 添加自定义字体
+
+## 添加额外的脚本
+
+## 添加 SVG Icons
+
+## 使用图片
diff --git a/docs/guide/config_changes.md → docs/guides/config_changes.md b/docs/guide/config_changes.md → docs/guides/config_changes.md
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -0,0 +1,3 @@
+---
+title: 指南
+---
diff --git a/docs/guides/index.zh-CN.md b/docs/guides/index.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 指南
+---
diff --git a/docs/guides/migrate-from-cra.md b/docs/guides/migrate-from-cra.md
@@ -0,0 +1,3 @@
+---
+title: 迁移 create-react-app 项目到 umi
+---
diff --git a/docs/guides/migrate-from-cra.zh-CN.md b/docs/guides/migrate-from-cra.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 迁移 create-react-app 项目到 umi
+---
diff --git a/docs/guides/ssr.md b/docs/guides/ssr.md
@@ -0,0 +1,3 @@
+---
+title: SSR 指南
+---
diff --git a/docs/guides/ssr.zh-CN.md b/docs/guides/ssr.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: SSR 指南
+---
diff --git a/docs/guides/with-antd-dva.md b/docs/guides/with-antd-dva.md
@@ -0,0 +1,3 @@
+---
+title: 创建 umi + antd + dva 的项目
+---
diff --git a/docs/guides/with-antd-dva.zh-CN.md b/docs/guides/with-antd-dva.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: 创建 umi + antd + dva 的项目
+---
diff --git a/docs/guides/with-micro-frontend.md b/docs/guides/with-micro-frontend.md
@@ -0,0 +1,3 @@
+---
+title: Umi 和微前端
+---
diff --git a/docs/guides/with-micro-frontend.zh-CN.md b/docs/guides/with-micro-frontend.zh-CN.md
@@ -0,0 +1,3 @@
+---
+title: Umi 和微前端
+---
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,13 @@
+---
+hero:
+  title: UmiJS
+  desc: balabala
+  actions:
+    - title: Get Started →
+      link: /
+features:
+  - title: Balabala
+    desc: Balabala
+---
+
+Umi Home page
diff --git a/docs/index.zh-CN.md b/docs/index.zh-CN.md
@@ -0,0 +1,13 @@
+---
+hero:
+  title: UmiJS
+  desc: balabala
+  actions:
+    - title: Get Started →
+      link: /
+features:
+  - title: Balabala
+    desc: Balabala
+---
+
+Umi 首页