From 1524672f6ee85b201c30bed1c5c080a87bb928fc Mon Sep 17 00:00:00 2001 From: "sh.szx" Date: Thu, 30 Dec 2021 11:13:20 +0800 Subject: [PATCH] chore: migrate to dumi --- .fatherrc.js | 1 - .gitignore | 8 +++++++- .umirc.ts | 8 ++++++++ README.md | 3 +++ docs/demo/simple.md | 3 +++ {examples => docs/examples}/simple.jsx | 4 ++-- package.json | 7 ++++--- 7 files changed, 27 insertions(+), 7 deletions(-) create mode 100644 .umirc.ts create mode 100644 docs/demo/simple.md rename {examples => docs/examples}/simple.jsx (98%) diff --git a/.fatherrc.js b/.fatherrc.js index c88ea52..571c236 100644 --- a/.fatherrc.js +++ b/.fatherrc.js @@ -2,7 +2,6 @@ export default { entry: ['src/index.js'], cjs: 'babel', esm: { type: 'babel', importLibToEs: true }, - doc: { base: '/checkbox' }, preCommit: { eslint: true, prettier: true, diff --git a/.gitignore b/.gitignore index 9d56ef4..d0036e2 100644 --- a/.gitignore +++ b/.gitignore @@ -28,4 +28,10 @@ build lib es coverage -yarn.lock \ No newline at end of file +yarn.lock + +# dumi +.umi +.umi-production +.umi-test +.docs \ No newline at end of file diff --git a/.umirc.ts b/.umirc.ts new file mode 100644 index 0000000..33a8fa4 --- /dev/null +++ b/.umirc.ts @@ -0,0 +1,8 @@ +// more config: https://d.umijs.org/config +import { defineConfig } from 'dumi'; + +export default defineConfig({ + title: 'rc-checkbox', + outputPath: '.docs', + exportStatic: {}, +}); \ No newline at end of file diff --git a/README.md b/README.md index d19faf2..6aa6098 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Checkbox ui component for react. [![DevDependencies][david-dev-image]][david-dev-url] [![npm download][download-image]][download-url] [![bundle size][bundlephobia-image]][bundlephobia-url] +[![dumi][dumi-image]][dumi-url] [npm-image]: http://img.shields.io/npm/v/rc-checkbox.svg?style=flat-square [npm-url]: http://npmjs.org/package/rc-checkbox @@ -28,6 +29,8 @@ Checkbox ui component for react. [download-url]: https://npmjs.org/package/rc-checkbox [bundlephobia-url]: https://bundlephobia.com/result?p=rc-checkbox [bundlephobia-image]: https://badgen.net/bundlephobia/minzip/rc-checkbox +[dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square +[dumi-url]: https://github.com/umijs/dumi ## Install diff --git a/docs/demo/simple.md b/docs/demo/simple.md new file mode 100644 index 0000000..dd7fb36 --- /dev/null +++ b/docs/demo/simple.md @@ -0,0 +1,3 @@ +## Simple + + \ No newline at end of file diff --git a/examples/simple.jsx b/docs/examples/simple.jsx similarity index 98% rename from examples/simple.jsx rename to docs/examples/simple.jsx index 92f4b1b..e201972 100644 --- a/examples/simple.jsx +++ b/docs/examples/simple.jsx @@ -1,7 +1,7 @@ /* eslint no-console:0, jsx-a11y/label-has-for: 0, jsx-a11y/label-has-associated-control: 0 */ import React from 'react'; -import Checkbox from '../src'; -import '../assets/index.less'; +import Checkbox from 'rc-checkbox'; +import '../../assets/index.less'; function onChange(e) { console.log('Checkbox checked:', e.target.checked); diff --git a/package.json b/package.json index 599e972..2be075c 100644 --- a/package.json +++ b/package.json @@ -25,10 +25,10 @@ }, "license": "MIT", "scripts": { - "start": "father doc dev --storybook", - "build": "father doc build --storybook", + "start": "dumi dev", + "build": "dumi build", "compile": "father build && lessc assets/index.less assets/index.css", - "gh-pages": "father doc deploy", + "gh-pages": "npm run build && father doc deploy -d .docs", "prepublishOnly": "npm run compile && np --yolo --no-publish", "lint": "eslint . --ext='jsx'", "test": "father test", @@ -43,6 +43,7 @@ "@types/jest": "^26.0.5", "@umijs/fabric": "^2.2.2", "coveralls": "^3.0.6", + "dumi": "^1.1.37", "enzyme": "^3.0.0", "enzyme-adapter-react-16": "^1.0.1", "enzyme-to-json": "^3.0.0",