diff --git a/.gitignore b/.gitignore index f861fc87..390af022 100644 --- a/.gitignore +++ b/.gitignore @@ -30,4 +30,9 @@ package-lock.json coverage/ .doc dist -.vscode \ No newline at end of file +.vscode +# umi +.umi +.umi-production +.umi-test +.env.local diff --git a/.umirc.ts b/.umirc.ts new file mode 100644 index 00000000..f3148c85 --- /dev/null +++ b/.umirc.ts @@ -0,0 +1,19 @@ +// more config: https://d.umijs.org/config +import { defineConfig } from 'dumi'; + +export default defineConfig({ + title: 'rc-pagination', + favicon: + 'https://avatars0.githubusercontent.com/u/9441414?s=200&v=4', + logo: + 'https://avatars0.githubusercontent.com/u/9441414?s=200&v=4', + outputPath: '.doc', + exportStatic: {}, + styles: [ + ` + .markdown table { + width: auto !important; + } + `, + ] +}); diff --git a/HISTORY.md b/CHANGELOG.md similarity index 100% rename from HISTORY.md rename to CHANGELOG.md diff --git a/README.md b/README.md index 8c56e31d..99312467 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,8 @@ # rc-pagination ---- - React Pagination Component. -[![NPM version][npm-image]][npm-url] -[![build status][github-actions-image]][github-actions-url] -[![Test coverage][coveralls-image]][coveralls-url] -[![codecov](https://codecov.io/gh/react-component/pagination/branch/master/graph/badge.svg)](https://codecov.io/gh/react-component/pagination) -[![Dependencies](https://img.shields.io/david/react-component/pagination.svg?style=flat-square)](https://david-dm.org/react-component/pagination) -[![DevDependencies](https://img.shields.io/david/dev/react-component/pagination.svg?style=flat-square)](https://david-dm.org/react-component/pagination?type=dev) -[![npm download][download-image]][download-url] +[![NPM version][npm-image]][npm-url] [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square)](https://github.com/umijs/dumi) [![build status][github-actions-image]][github-actions-url] [![Test coverage][coveralls-image]][coveralls-url] [![codecov](https://codecov.io/gh/react-component/pagination/branch/master/graph/badge.svg)](https://codecov.io/gh/react-component/pagination) [![Dependencies](https://img.shields.io/david/react-component/pagination.svg?style=flat-square)](https://david-dm.org/react-component/pagination) [![DevDependencies](https://img.shields.io/david/dev/react-component/pagination.svg?style=flat-square)](https://david-dm.org/react-component/pagination?type=dev) [![npm download][download-image]][download-url] [npm-image]: http://img.shields.io/npm/v/rc-pagination.svg?style=flat-square [npm-url]: http://npmjs.org/package/rc-pagination @@ -32,7 +24,7 @@ npm start http://localhost:9001 -online example: http://react-component.github.io/pagination/ +online example: https://pagination-react-component.vercel.app ## Install diff --git a/docs/demo/default.md b/docs/demo/default.md new file mode 100644 index 00000000..3c5816ad --- /dev/null +++ b/docs/demo/default.md @@ -0,0 +1,3 @@ +## default + + diff --git a/docs/demo/itemRender.md b/docs/demo/itemRender.md new file mode 100644 index 00000000..d53b1dcc --- /dev/null +++ b/docs/demo/itemRender.md @@ -0,0 +1,3 @@ +## itemRender + + diff --git a/docs/demo/jumper.md b/docs/demo/jumper.md new file mode 100644 index 00000000..c9e88b5a --- /dev/null +++ b/docs/demo/jumper.md @@ -0,0 +1,3 @@ +## jumper + + diff --git a/docs/demo/jumperWithGoButton.md b/docs/demo/jumperWithGoButton.md new file mode 100644 index 00000000..f9f72f1a --- /dev/null +++ b/docs/demo/jumperWithGoButton.md @@ -0,0 +1,3 @@ +## jumperWithGoButton + + diff --git a/docs/demo/lessPages.md b/docs/demo/lessPages.md new file mode 100644 index 00000000..02e2e2d1 --- /dev/null +++ b/docs/demo/lessPages.md @@ -0,0 +1,3 @@ +## lessPages + + diff --git a/docs/demo/locale.md b/docs/demo/locale.md new file mode 100644 index 00000000..2bc00d5e --- /dev/null +++ b/docs/demo/locale.md @@ -0,0 +1,3 @@ +## locale + + diff --git a/docs/demo/more.md b/docs/demo/more.md new file mode 100644 index 00000000..97d88320 --- /dev/null +++ b/docs/demo/more.md @@ -0,0 +1,3 @@ +## more + + diff --git a/docs/demo/showTitle.md b/docs/demo/showTitle.md new file mode 100644 index 00000000..65669cd5 --- /dev/null +++ b/docs/demo/showTitle.md @@ -0,0 +1,3 @@ +## showTitle + + diff --git a/docs/demo/showTotal.md b/docs/demo/showTotal.md new file mode 100644 index 00000000..81afa3b1 --- /dev/null +++ b/docs/demo/showTotal.md @@ -0,0 +1,3 @@ +## showTotal + + diff --git a/docs/demo/simple.md b/docs/demo/simple.md new file mode 100644 index 00000000..e3146039 --- /dev/null +++ b/docs/demo/simple.md @@ -0,0 +1,3 @@ +## simple + + diff --git a/docs/demo/sizer.md b/docs/demo/sizer.md new file mode 100644 index 00000000..ade2fefe --- /dev/null +++ b/docs/demo/sizer.md @@ -0,0 +1,3 @@ +## sizer + + diff --git a/docs/demo/stupid.md b/docs/demo/stupid.md new file mode 100644 index 00000000..9f20e71e --- /dev/null +++ b/docs/demo/stupid.md @@ -0,0 +1,3 @@ +## stupid + + diff --git a/docs/demo/styles.md b/docs/demo/styles.md new file mode 100644 index 00000000..44cc7a16 --- /dev/null +++ b/docs/demo/styles.md @@ -0,0 +1,3 @@ +## styles + + diff --git a/examples/default.js b/docs/examples/default.js similarity index 85% rename from examples/default.js rename to docs/examples/default.js index 5ec50146..02e9eecb 100644 --- a/examples/default.js +++ b/docs/examples/default.js @@ -1,7 +1,7 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; import 'rc-select/assets/index.less'; export default class App extends React.Component { diff --git a/examples/itemRender.js b/docs/examples/itemRender.js similarity index 93% rename from examples/itemRender.js rename to docs/examples/itemRender.js index e6a59ef8..9e9a8daf 100644 --- a/examples/itemRender.js +++ b/docs/examples/itemRender.js @@ -1,6 +1,6 @@ -import '../assets/index.less'; +import '../../assets/index.less'; import React from 'react'; -import Pagination from '..'; +import Pagination from 'rc-pagination'; const itemRender = (current, type, element) => { if (type === 'page') { diff --git a/examples/jumper.js b/docs/examples/jumper.js similarity index 92% rename from examples/jumper.js rename to docs/examples/jumper.js index c838434f..e5867964 100644 --- a/examples/jumper.js +++ b/docs/examples/jumper.js @@ -1,8 +1,8 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; import Select from 'rc-select'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; import 'rc-select/assets/index.less'; function onShowSizeChange(current, pageSize) { diff --git a/examples/jumperWithGoButton.js b/docs/examples/jumperWithGoButton.js similarity index 93% rename from examples/jumperWithGoButton.js rename to docs/examples/jumperWithGoButton.js index f92c9432..a2b12e5c 100644 --- a/examples/jumperWithGoButton.js +++ b/docs/examples/jumperWithGoButton.js @@ -1,8 +1,8 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; import Select from 'rc-select'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; import 'rc-select/assets/index.less'; class App extends React.Component { diff --git a/examples/lessPages.js b/docs/examples/lessPages.js similarity index 97% rename from examples/lessPages.js rename to docs/examples/lessPages.js index 6796cfc7..160b6713 100644 --- a/examples/lessPages.js +++ b/docs/examples/lessPages.js @@ -1,7 +1,7 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; const arrowPath = 'M869 487.8L491.2 159.9c-2.9-2.5-6.6-3.9-10.5-3.9h' + diff --git a/examples/locale.js b/docs/examples/locale.js similarity index 83% rename from examples/locale.js rename to docs/examples/locale.js index 94bfaa25..fc9ec122 100644 --- a/examples/locale.js +++ b/docs/examples/locale.js @@ -1,9 +1,9 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; import Select from 'rc-select'; -import Pagination from '..'; -import localeInfo from '../src/locale/en_US'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import localeInfo from 'rc-pagination/locale/en_US'; +import '../../assets/index.less'; import 'rc-select/assets/index.less'; function onShowSizeChange(current, pageSize) { diff --git a/examples/more.js b/docs/examples/more.js similarity index 66% rename from examples/more.js rename to docs/examples/more.js index 5cf92376..b8f3039c 100644 --- a/examples/more.js +++ b/docs/examples/more.js @@ -1,6 +1,6 @@ -import '../assets/index.less'; +import '../../assets/index.less'; import React from 'react'; -import Pagination from '..'; +import Pagination from 'rc-pagination'; const App = () => ( diff --git a/examples/showTitle.js b/docs/examples/showTitle.js similarity index 89% rename from examples/showTitle.js rename to docs/examples/showTitle.js index e22a81b6..dc37b0ab 100644 --- a/examples/showTitle.js +++ b/docs/examples/showTitle.js @@ -1,7 +1,7 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; class App extends React.Component { state = { diff --git a/examples/showTotal.js b/docs/examples/showTotal.js similarity index 85% rename from examples/showTotal.js rename to docs/examples/showTotal.js index c0425caa..0ee1c369 100644 --- a/examples/showTotal.js +++ b/docs/examples/showTotal.js @@ -1,6 +1,6 @@ import React from 'react'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; const App = () => ( <> diff --git a/examples/simple.js b/docs/examples/simple.js similarity index 82% rename from examples/simple.js rename to docs/examples/simple.js index b9963ccc..b3299f2c 100644 --- a/examples/simple.js +++ b/docs/examples/simple.js @@ -1,6 +1,6 @@ -import '../assets/index.less'; +import '../../assets/index.less'; import React from 'react'; -import Pagination from '..'; +import Pagination from 'rc-pagination'; const App = () => ( <> diff --git a/examples/sizer.js b/docs/examples/sizer.js similarity index 94% rename from examples/sizer.js rename to docs/examples/sizer.js index 28407bab..19212bc2 100644 --- a/examples/sizer.js +++ b/docs/examples/sizer.js @@ -1,8 +1,8 @@ /* eslint func-names: 0, no-console: 0 */ import React from 'react'; import Select from 'rc-select'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; import 'rc-select/assets/index.less'; class App extends React.Component { diff --git a/examples/stupid.js b/docs/examples/stupid.js similarity index 57% rename from examples/stupid.js rename to docs/examples/stupid.js index d4456b36..a4e6d778 100644 --- a/examples/stupid.js +++ b/docs/examples/stupid.js @@ -1,5 +1,5 @@ import React from 'react'; -import Pagination from '..'; -import '../assets/index.less'; +import Pagination from 'rc-pagination'; +import '../../assets/index.less'; export default () => ; diff --git a/examples/styles.js b/docs/examples/styles.js similarity index 63% rename from examples/styles.js rename to docs/examples/styles.js index 6931b939..e05597dc 100644 --- a/examples/styles.js +++ b/docs/examples/styles.js @@ -1,6 +1,6 @@ -import '../assets/index.less'; +import '../../assets/index.less'; import React from 'react'; -import Pagination from '..'; +import Pagination from 'rc-pagination'; export default () => ( diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..db78acdb --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +--- +title: rc-image +--- + + diff --git a/index.js b/index.js deleted file mode 100644 index fd4d7e5c..00000000 --- a/index.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = require('./src/'); diff --git a/now.json b/now.json index 838525d8..76a11f8b 100644 --- a/now.json +++ b/now.json @@ -7,5 +7,8 @@ "use": "@now/static-build", "config": { "distDir": ".doc" } } + ], + "routes": [ + { "src": "/(.*)", "dest": "/dist/$1" } ] } diff --git a/package.json b/package.json index d3117327..c655b43f 100644 --- a/package.json +++ b/package.json @@ -31,16 +31,17 @@ }, "license": "MIT", "scripts": { - "start": "cross-env NODE_ENV=development father doc dev --storybook", - "build": "father doc build --storybook", + "start": "dumi dev", + "docs:build": "dumi build", + "docs:deploy": "gh-pages -d docs-dist", "compile": "father build && lessc assets/index.less assets/index.css", - "gh-pages": "npm run build && father doc deploy", "prepublishOnly": "npm run compile && np --yolo --no-publish && npm run gh-pages", "lint": "eslint src/ --ext .ts,.tsx,.jsx,.js,.md", "prettier": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\"", "pretty-quick": "pretty-quick", "test": "father test", - "coverage": "father test --coverage" + "coverage": "father test --coverage", + "now-build": "npm run docs:build" }, "dependencies": { "@babel/runtime": "^7.10.1", @@ -54,11 +55,13 @@ "@umijs/fabric": "^2.0.3", "coveralls": "^3.0.6", "cross-env": "^7.0.0", + "dumi": "^1.1.7", "enzyme": "^3.0.0", "enzyme-adapter-react-16": "^1.0.1", "enzyme-to-json": "^3.4.0", "eslint": "^7.0.0", "father": "^2.13.4", + "glob": "^7.1.6", "less": "^3.10.3", "np": "^7.0.0", "prettier": "^2.0.1", diff --git a/tsconfig.json b/tsconfig.json index 2f0b5855..0976a47b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -5,10 +5,16 @@ "lib": ["dom", "es2017"], "jsx": "react", "strict": true, + "baseUrl": "./", "esModuleInterop": true, "experimentalDecorators": true, "emitDecoratorMetadata": true, "skipLibCheck": true, - "declaration": true + "declaration": true, + "paths": { + "@/*": ["src/*"], + "@@/*": ["src/.umi/*"], + "rc-pagination": ["src/index.js"] + } } } diff --git a/update-example.js b/update-example.js new file mode 100644 index 00000000..1efdf108 --- /dev/null +++ b/update-example.js @@ -0,0 +1,31 @@ +/* + 用于 dumi 改造使用， + 可用于将 examples 的文件批量修改为 demo 引入形式， + 其他项目根据具体情况使用。 +*/ + +const fs = require('fs'); +const glob = require('glob'); + +const suffix = '.js'; + +const paths = glob.sync(`./docs/examples/*${suffix}`); + +paths.forEach(path => { + const name = path.split('/').pop().split('.')[0]; + fs.writeFile( + `./docs/demo/${name}.md`, + `## ${name} + + +`, + 'utf8', + function(error) { + if(error){ + console.log(error); + return false; + } + console.log(`${name} 更新成功~`); + } + ) +});