@antv/dumi-theme-antv

@antv/dumi-theme-antv

A theme package for the dumi framework.

Usage

Install this theme into devDependencies:

$ npm i @antv/dumi-theme-antv -D

Configure it in dumi config file .dumirc.ts:

import { defineConfig } from 'dumi';

export defineConfig({
  themeConfig: {
    ...
  },
});

That's all, now you can execute dumi dev and enjoy this theme.

Options

TODO

themeConfig.docsearchOptions.sort 用于配置搜索结果的排序规则。可以通过字符串数组来定义排序逻辑。

• 每个字符串可以是一个路径片段，用于匹配搜索结果的链接。
• 如果字符串以 ! 开头，则表示不包含该路径片段的结果应排在包含该路径片段的结果之前。

Development

$ npm install

After the dependencies are installed, a symlink from example/.dumi/theme to ../../src will be created automatically, the symlink makes dumi load our theme package as a local theme, so we can start the example directly, HMR is also available:

# switch to example directory
$ cd example

# downloads the dependencies
npm install

# start dev server to preview
npm run dev

dumi theme development documentation: https://next.d.umijs.org/theme

LICENSE

MIT