diff --git a/example/.dumirc.ts b/example/.dumirc.ts index b058104..0a65a35 100644 --- a/example/.dumirc.ts +++ b/example/.dumirc.ts @@ -1,7 +1,7 @@ import { defineConfig } from 'dumi'; import path from 'path'; -import { homepage } from '../package.json'; +import { homepage, name } from '../package.json'; import { features } from './config/features'; @@ -39,8 +39,11 @@ export default defineConfig({ ], }, features, + apiHeader: { - match: ['/components'], + pkg: name, + sourceUrl: `{github}/tree/master/src/components/{atomId}/index.tsx`, + docUrl: `{github}/tree/master/example/docs/components/{atomId}.{locale}.md`, }, }, diff --git a/example/docs/components/DumiSiteProvider.zh-CN.md b/example/docs/components/DumiSiteProvider.zh-CN.md index 8632ce9..1ad6019 100644 --- a/example/docs/components/DumiSiteProvider.zh-CN.md +++ b/example/docs/components/DumiSiteProvider.zh-CN.md @@ -1,7 +1,7 @@ --- order: 2 title: DumiSiteProvider 主题容器 -apiHeader: true +atomId: DumiSiteProvider group: title: 其他 order: 100 diff --git a/example/docs/components/Features.zh-CN.md b/example/docs/components/Features.zh-CN.md index 03a25ff..da1ae81 100644 --- a/example/docs/components/Features.zh-CN.md +++ b/example/docs/components/Features.zh-CN.md @@ -1,18 +1,19 @@ --- order: 2 title: Features 特性 -apiHeader: true +description: 首页的特性组件 +atomId: Features group: 风格化组件 --- -:::info -只有包裹在 `DumiSiteProvider` 里面才能正常使用。 -::: - ## Demo +:::info +只有包裹在 `DumiSiteProvider` 里面才能正常使用。 +::: + ## API | 属性名 | 描述 | 类型 | 默认值 | diff --git a/example/docs/components/Footer.zh-CN.md b/example/docs/components/Footer.zh-CN.md index 1949eff..3a743ed 100644 --- a/example/docs/components/Footer.zh-CN.md +++ b/example/docs/components/Footer.zh-CN.md @@ -1,6 +1,7 @@ --- title: Footer 页脚 -apiHeader: true +atomId: Footer +description: 页面布局的页脚，基于 rc-footer 封装 group: title: 布局 --- diff --git a/example/docs/components/Hero.zh-CN.md b/example/docs/components/Hero.zh-CN.md index 7a91415..273e5fe 100644 --- a/example/docs/components/Hero.zh-CN.md +++ b/example/docs/components/Hero.zh-CN.md @@ -1,20 +1,21 @@ --- order: 1 title: Hero 头图 -apiHeader: true +atomId: Hero +description: 风格化头图 group: title: 风格化组件 order: 2 --- -:::info -只有包裹在 `DumiSiteProvider` 里面才能正常使用。 -::: - ## Demo +:::info +只有包裹在 `DumiSiteProvider` 里面才能正常使用。 +::: + ## API | 属性名 | 描述 | 类型 | 默认值 | diff --git a/example/docs/components/Highlighter.zh-CN.md b/example/docs/components/Highlighter.zh-CN.md index 8cd146a..00158c5 100644 --- a/example/docs/components/Highlighter.zh-CN.md +++ b/example/docs/components/Highlighter.zh-CN.md @@ -1,14 +1,11 @@ --- title: Highlighter 语法高亮器 -apiHeader: true +atomId: Highlighter +description: 代码高亮组件，基于 Shiki 和 Prism 两种语法高亮引擎封装 group: title: 功能组件 --- -:::info -只有包裹在 `DumiSiteProvider` 里面才能正常使用。 -::: - ## Demo ## Shiki 语法高亮器 @@ -27,6 +24,10 @@ group: +:::info +只有包裹在 `DumiSiteProvider` 里面才能正常使用。 +::: + ## API 请查阅类型定义 diff --git a/example/docs/components/Toc.zh-CN.md b/example/docs/components/Toc.zh-CN.md index 5f66131..c7cc578 100644 --- a/example/docs/components/Toc.zh-CN.md +++ b/example/docs/components/Toc.zh-CN.md @@ -1,6 +1,7 @@ --- title: Toc 目录 -apiHeader: true +atomId: Toc +description: 页面目录组件 group: title: 布局 --- diff --git a/example/docs/components/demos/DumiSiteProvider.tsx b/example/docs/components/demos/DumiSiteProvider.tsx index 9cc9d9d..e58dcb7 100644 --- a/example/docs/components/demos/DumiSiteProvider.tsx +++ b/example/docs/components/demos/DumiSiteProvider.tsx @@ -2,40 +2,19 @@ * iframe: 460 */ import { useAntdTheme, useTheme } from 'antd-style'; -import { DumiSiteProvider } from 'dumi-theme-antd-style'; +import { DumiSiteProvider, Highlighter } from 'dumi-theme-antd-style'; import { omit } from 'lodash'; -import { JSONTree } from 'react-json-tree'; import { Flexbox } from 'react-layout-kit'; -const jsonTheme = { - scheme: 'monokai', - author: 'wimer hazenberg (http://www.monokai.nl)', - base00: '#272822', - base01: '#383830', - base02: '#49483e', - base03: '#75715e', - base04: '#a59f85', - base05: '#f8f8f2', - base06: '#f5f4f1', - base07: '#f9f8f5', - base08: '#f92672', - base09: '#fd971f', - base0A: '#f4bf75', - base0B: '#a6e22e', - base0C: '#a1efe4', - base0D: '#66d9ef', - base0E: '#ae81ff', - base0F: '#cc6633', -}; - const App = () => { const antdTheme = useAntdTheme(); const theme = useTheme(); const siteTheme = omit(theme, Object.keys(antdTheme)); + const json = JSON.stringify(siteTheme, null, 2); return ( - + DumiSiteProvider 主题配置： - + {json} ); }; diff --git a/example/docs/components/index.zh-CN.md b/example/docs/components/index.zh-CN.md index af58a21..fb3f260 100644 --- a/example/docs/components/index.zh-CN.md +++ b/example/docs/components/index.zh-CN.md @@ -1,9 +1,10 @@ --- order: 1 title: 概览 +apiHeader: false nav: title: 组件 - order: 3 + order: 4 --- # 主题组件 diff --git a/example/docs/config.zh-CN.md b/example/docs/config.zh-CN.md index 4135d0f..31d9212 100644 --- a/example/docs/config.zh-CN.md +++ b/example/docs/config.zh-CN.md @@ -81,26 +81,22 @@ export default defineConfig({ 该配置底层使用本主题包的 Feature 组件，详见 [Features](/components/features) 文档。 -### sidebarGroupModePath +## 高级配置 -- 类型：`Array` +### apiHeader + +- 类型：`` - 默认值：`[]` ```ts -export default { +export default defineConfig({ themeConfig: { - antdTheme: { - sidebarGroupModePath: [ - // 匹配以 /config 开头的路由 - '/config', - // 支持正则匹配 - /\/guide\//, - ], + apiHeader: { + // 组件库包名，可以从 package.json 中引入名称 + pkg: 'dumi-theme-antd-style', + // 匹配路由，默认为 /api 或 /components + match: ['/api', '/components'], }, }, -}; +}); ``` - -左侧导航栏是否需要作为分组处理，参考 antd [menuitemgrouptype][antd-menuitemgrouptype-url]。 - -[antd-menuitemgrouptype-url]: https://ant.design/components/menu-cn#menuitemgrouptype--- diff --git a/example/package.json b/example/package.json index 33a1082..d059767 100644 --- a/example/package.json +++ b/example/package.json @@ -5,8 +5,5 @@ "preview": "dumi preview", "setup": "dumi setup", "start": "dumi dev" - }, - "devDependencies": { - "react-json-tree": "^0.18" } }