Skip to content

Commit 0cdee2f

Browse files
committed
feat: docs
1 parent 072556f commit 0cdee2f

File tree

15 files changed

+646
-1
lines changed

15 files changed

+646
-1
lines changed

.editorconfig

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false
14+
15+
[Makefile]
16+
indent_style = tab

.fatherrc.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export default {
2+
esm: 'rollup',
3+
cjs: 'rollup',
4+
};

.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/npm-debug.log*
6+
/yarn-error.log
7+
/yarn.lock
8+
/package-lock.json
9+
10+
# production
11+
/dist
12+
/docs-dist
13+
14+
# misc
15+
.DS_Store
16+
17+
# umi
18+
.umi
19+
.umi-production
20+
.umi-test
21+
.env.local
22+
23+
# ide
24+
/.vscode
25+
/.idea

.prettierignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**/*.svg
2+
**/*.ejs
3+
**/*.html
4+
package.json
5+
.umi
6+
.umi-production
7+
.umi-test

.prettierrc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"singleQuote": true,
3+
"trailingComma": "all",
4+
"printWidth": 80,
5+
"overrides": [
6+
{
7+
"files": ".prettierrc",
8+
"options": { "parser": "json" }
9+
}
10+
]
11+
}

.umirc.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { defineConfig } from 'dumi';
2+
3+
export default defineConfig({
4+
title: 'querycap前端',
5+
favicon:
6+
'https://user-images.githubusercontent.com/9554297/83762004-a0761b00-a6a9-11ea-83b4-9c8ff721d4b8.png',
7+
logo:
8+
'https://user-images.githubusercontent.com/9554297/83762004-a0761b00-a6a9-11ea-83b4-9c8ff721d4b8.png',
9+
outputPath: 'docs-dist',
10+
mode: 'site',
11+
// more config: https://d.umijs.org/config
12+
});

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
# querycap.github.io
1+
# querycap.github.io
2+
3+
## 快速开始
4+
5+
Install dependencies,
6+
7+
```bash
8+
$ npm i
9+
```
10+
11+
Start the dev server,
12+
13+
```bash
14+
$ npm start
15+
```
16+
17+
Build documentation,
18+
19+
```bash
20+
$ npm run docs:build
21+
```
22+
23+
Build library via `father-build`,
24+
25+
```bash
26+
$ npm run build
27+
```

docs/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
hero:
3+
title: Web前端
4+
desc: 基础开发文档
5+
actions:
6+
- text: 快速开始
7+
link: /guide
8+
features:
9+
- icon: https://gw.alipayobjects.com/zos/bmw-prod/881dc458-f20b-407b-947a-95104b5ec82b/k79dm8ih_w144_h144.png
10+
title: 开箱即用
11+
desc: Balabala
12+
- icon: https://gw.alipayobjects.com/zos/bmw-prod/d60657df-0822-4631-9d7c-e7a869c2f21c/k79dmz3q_w126_h126.png
13+
title: 快速开发
14+
desc: Balabala
15+
- icon: https://gw.alipayobjects.com/zos/bmw-prod/d1ee0c6f-5aed-4a45-a507-339a4bfe076c/k7bjsocq_w144_h144.png
16+
title: 组件开发
17+
desc: Balabala
18+
footer: Open-source MIT Licensed | Copyright © 2020<br />Powered by [dumi](https://d.umijs.org)
19+
---
20+
21+
## Hello querycap.github.io!

package.json

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"private": true,
3+
"name": "querycap.github.io",
4+
"version": "1.0.0",
5+
"scripts": {
6+
"start": "dumi dev",
7+
"docs:build": "dumi build",
8+
"docs:deploy": "gh-pages -d docs-dist",
9+
"build": "father-build",
10+
"deploy": "npm run docs:build && npm run docs:deploy",
11+
"release": "npm run build && npm publish",
12+
"prettier": "prettier --write \"**/*.{js,jsx,tsx,ts,less,md,json}\"",
13+
"test": "umi-test",
14+
"test:coverage": "umi-test --coverage"
15+
},
16+
"main": "dist/index.js",
17+
"module": "dist/index.esm.js",
18+
"typings": "dist/index.d.ts",
19+
"gitHooks": {
20+
"pre-commit": "lint-staged"
21+
},
22+
"lint-staged": {
23+
"*.{js,jsx,less,md,json}": [
24+
"prettier --write"
25+
],
26+
"*.ts?(x)": [
27+
"prettier --parser=typescript --write"
28+
]
29+
},
30+
"dependencies": {
31+
"react": "^16.12.0"
32+
},
33+
"devDependencies": {
34+
"@umijs/test": "^3.0.5",
35+
"dumi": "^1.0.13",
36+
"father-build": "^1.17.2",
37+
"gh-pages": "^3.0.0",
38+
"lint-staged": "^10.0.7",
39+
"prettier": "^1.19.1",
40+
"yorkie": "^2.0.0"
41+
}
42+
}

0 commit comments

Comments
 (0)