@antv/dumi-theme-antv 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -2,8 +2,54 @@
|
|
|
2
2
|
|
|
3
3
|
dumi theme for antv site
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Install
|
|
6
6
|
|
|
7
7
|
```
|
|
8
8
|
yarn add @antv/dumi-theme-antv --save-dev
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
> Refer to the documentation for the [Dumi theme](https://d.umijs.org/zh-CN/config#themeconfig)
|
|
15
|
+
|
|
16
|
+
<strong >note ⚠️<strong>
|
|
17
|
+
Since `*.module.less` is used in `@antv/dumi-theme-antv`, extraBabelIncludes needs to be configured:
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
export default {
|
|
21
|
+
//...
|
|
22
|
+
mode: "site",
|
|
23
|
+
extraBabelIncludes: ["@antv/dumi-theme-antv"],
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Contributing
|
|
28
|
+
|
|
29
|
+
### Development install
|
|
30
|
+
|
|
31
|
+
- start `@antv/dumi-theme-antv`
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
- 1. git clone https://github.com/antvis/dumi-theme-antv.git
|
|
35
|
+
- 2. yarn // install deps
|
|
36
|
+
- 3. npm run start //start dev
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- start demo of antv sub product site
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
|
|
44
|
+
- 1. npm link
|
|
45
|
+
|
|
46
|
+
- 2. cd site
|
|
47
|
+
|
|
48
|
+
- 3. note: remove `@antv/dumi-theme-antv` from `devDependencies` in `package.json`
|
|
49
|
+
|
|
50
|
+
- 4. yarn // install deps
|
|
51
|
+
|
|
52
|
+
- 5. npm link @antv/dumi-theme-antv
|
|
53
|
+
|
|
54
|
+
- 6. npm run start
|
|
9
55
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antv/dumi-theme-antv",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "The official antv site theme of dumi",
|
|
5
5
|
"files": [
|
|
6
6
|
"es",
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
"i18next": "^21.6.14",
|
|
26
26
|
"lodash": "^4.17.21",
|
|
27
27
|
"lodash.throttle": "^4.1.1",
|
|
28
|
+
"omit.js": "^2.0.2",
|
|
28
29
|
"parse-github-url": "^1.0.2",
|
|
29
30
|
"prism-react-renderer": "^1.1.1",
|
|
30
31
|
"prismjs": "^1.21.0",
|