diff --git a/.umirc.ts b/.umirc.ts index 080a94a..cfdaf83 100644 --- a/.umirc.ts +++ b/.umirc.ts @@ -11,7 +11,6 @@ export default defineConfig({ outputPath: 'docs-dist', mode: 'site', hash: true, - exportStatic: {}, // Because of using GitHub Pages base: `/${repo}/`, publicPath: `/${repo}/`, diff --git a/docs/index.md b/docs/index.md index 63670a3..92413c3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,9 @@ --- -title: dumi - A Umi-based doc tool can assist you to develop libraries & write docs. +title: dumi - A doc tool can assist you to develop libraries & write docs. +order: 10 hero: title: dumi - desc: A Umi-based doc tool can assist you to develop libraries & write docs. + desc: 📖 A doc tool can assist you to develop libraries & write docs. actions: - text: Getting Started link: /components/foo @@ -10,12 +11,21 @@ features: - icon: https://gw.alipayobjects.com/zos/bmw-prod/881dc458-f20b-407b-947a-95104b5ec82b/k79dm8ih_w144_h144.png title: Out of the box desc: Elegant default configrations and convention routing assist developers to get started as simple as possible, that focus all attentions on developing libraries & writting docs - - icon: https://gw.alipayobjects.com/zos/bmw-prod/d60657df-0822-4631-9d7c-e7a869c2f21c/k79dmz3q_w126_h126.png - title: high-performance - desc: Based on powerful Umi, dumi is not only high-performance & extensible, but also could use mostly plugins based on Umi - icon: https://gw.alipayobjects.com/zos/bmw-prod/d1ee0c6f-5aed-4a45-a507-339a4bfe076c/k7bjsocq_w144_h144.png title: For developing libraries - desc: Powerful Markdown extensions, that could embed demos or import external demos or even insert custom React components, make docs beautiful & better to use + desc: Rich Markdown extensions are not limited to rendering component demos, making component documents not only easy to write and manage, but also beautiful and easy to use + - icon: https://gw.alipayobjects.com/zos/bmw-prod/b8570f4d-c1b1-45eb-a1da-abff53159967/kj9t990h_w144_h144.png + title: Theme system + desc: Progressive custom theme capabilities, ranging from expanding your own Markdown tags to customizing complete theme packages, are up to you + - icon: https://gw.alipayobjects.com/zos/bmw-prod/b3e102cd-5dad-4046-a02a-be33241d1cc7/kj9t8oji_w144_h144.png + title: API automatically generated + desc: Component API can be automatically generated based on TypeScript type definitions, and components will always be『the same in appearance』 + - icon: https://gw.alipayobjects.com/zos/bmw-prod/3863e74a-7870-4874-b1e1-00a8cdf47684/kj9t7ww3_w144_h144.png + title: Mobile component library development + desc: Install the theme package to quickly enable mobile component R&D capabilities, built-in mobile HD rendering solution + - icon: https://gw.alipayobjects.com/zos/bmw-prod/f093e060-726e-471c-a53e-e988ed3f560c/kj9t9sk7_w144_h144.png + title: Asset dataization capabilities + desc: One-line command digitizes component assets, and standardized asset data can be connected with downstream productivity tools footer: Open-source MIT Licensed | Copyright © 2019-present
Powered by self --- diff --git a/docs/index.zh-CN.md b/docs/index.zh-CN.md index 6f25c62..5583394 100644 --- a/docs/index.zh-CN.md +++ b/docs/index.zh-CN.md @@ -1,8 +1,9 @@ --- -title: dumi - 基于 Umi、为组件开发场景而生的文档工具 +title: dumi - 为组件开发场景而生的文档工具 +order: 10 hero: title: dumi - desc: 基于 Umi、为组件开发场景而生的文档工具 + desc: 📖 为组件开发场景而生的文档工具 actions: - text: 快速上手 link: /zh-CN/components/foo @@ -10,12 +11,21 @@ features: - icon: https://gw.alipayobjects.com/zos/bmw-prod/881dc458-f20b-407b-947a-95104b5ec82b/k79dm8ih_w144_h144.png title: 开箱即用 desc: 考究的默认配置和约定式的目录结构，帮助开发者零成本上手，让所有注意力都能放在文档编写和组件开发上 - - icon: https://gw.alipayobjects.com/zos/bmw-prod/d60657df-0822-4631-9d7c-e7a869c2f21c/k79dmz3q_w126_h126.png - title: 高性能 - desc: 有强大的 Umi 做底座，天生高性能、可扩展，且可使用 Umi 生态中的大部分插件 - icon: https://gw.alipayobjects.com/zos/bmw-prod/d1ee0c6f-5aed-4a45-a507-339a4bfe076c/k7bjsocq_w144_h144.png title: 为组件开发而生 - desc: 独特的 Markdown 扩展，可嵌入 Demo、可导入外部 Demo 甚至插入自定义 React 组件，使得组件的文档不仅能看，还好用 + desc: 丰富的 Markdown 扩展，不止于渲染组件 demo，使得组件的文档不仅易于编写、管理，还好看、好用 + - icon: https://gw.alipayobjects.com/zos/bmw-prod/b8570f4d-c1b1-45eb-a1da-abff53159967/kj9t990h_w144_h144.png + title: 主题系统 + desc: 渐进式的自定义主题能力，小到扩展自己的 Markdown 标签，大到自定义完整主题包，全由你定 + - icon: https://gw.alipayobjects.com/zos/bmw-prod/b3e102cd-5dad-4046-a02a-be33241d1cc7/kj9t8oji_w144_h144.png + title: API 自动生成 + desc: 可基于 TypeScript 类型定义自动生成组件 API，组件永远『表里如一』 + - icon: https://gw.alipayobjects.com/zos/bmw-prod/3863e74a-7870-4874-b1e1-00a8cdf47684/kj9t7ww3_w144_h144.png + title: 移动端组件库研发 + desc: 安装主题包即可快速启用移动端组件研发能力，内置移动端高清渲染方案 + - icon: https://gw.alipayobjects.com/zos/bmw-prod/f093e060-726e-471c-a53e-e988ed3f560c/kj9t9sk7_w144_h144.png + title: 资产数据化能力 + desc: 一行命令将组件资产数据化，标准化的资产数据可与下游生产力工具串联 footer: Open-source MIT Licensed | Copyright © 2019-present
Powered by self --- diff --git a/package.json b/package.json index 17d1ab9..9faec0c 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,7 @@ }, "devDependencies": { "@umijs/test": "^3.0.5", - "dumi": "^1.1.0-rc.8", + "dumi": "^1.1.0", "father-build": "^1.19.1", "gh-pages": "^3.0.0", "lint-staged": "^10.0.7", diff --git a/src/Foo/index.md b/src/Foo/index.md index adfc607..d33c003 100644 --- a/src/Foo/index.md +++ b/src/Foo/index.md @@ -1,7 +1,6 @@ --- nav: title: Components - title.zh-CN: 组件 path: /components --- diff --git a/src/Foo/index.zh-CN.md b/src/Foo/index.zh-CN.md index 6719903..55de617 100644 --- a/src/Foo/index.zh-CN.md +++ b/src/Foo/index.zh-CN.md @@ -15,4 +15,4 @@ import { Foo } from 'dumi-template'; export default () => ; ``` -更多技巧：https://d.umijs.org/guide/demo-principle +[更多技巧](https://d.umijs.org/guide/demo-principle)