https://github.com/antvis/dumi-theme-antv
AntV website theme based on dumi2.
https://github.com/antvis/dumi-theme-antv
antv dumi-theme-antv
Last synced: 7 months ago
JSON representation
AntV website theme based on dumi2.
- Host: GitHub
- URL: https://github.com/antvis/dumi-theme-antv
- Owner: antvis
- License: mit
- Created: 2022-04-08T01:15:47.000Z (over 4 years ago)
- Default Branch: v3
- Last Pushed: 2024-10-28T11:44:19.000Z (over 1 year ago)
- Last Synced: 2024-10-29T21:05:30.126Z (over 1 year ago)
- Topics: antv, dumi-theme-antv
- Language: TypeScript
- Homepage: https://dumi-theme-antv.antv.vision/
- Size: 7.07 MB
- Stars: 20
- Watchers: 13
- Forks: 13
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @antv/dumi-theme-antv
[](https://npmjs.org/package/@antv/dumi-theme-antv) [](https://npmjs.org/package/@antv/dumi-theme-antv)
A theme package for the [dumi](https://next.d.umijs.org) framework.
## Usage
Install this theme into `devDependencies`:
```bash
$ npm i @antv/dumi-theme-antv -D
```
Configure it in dumi config file `.dumirc.ts`:
```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
```bash
$ 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:
```bash
# 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