Skip to content

Commit

Permalink
chore: prettier to handle md files
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaofan2406 committed Jul 18, 2022
1 parent 8dcfcdb commit 8b4e5b5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
"dist": "npm run clean && npm run copy-types && npm run dist:lib && npm run dist:es && npm run dist:prod && npm run generate-docs && npm run dist:demo",
"lint:eslint": "eslint --ext .jsx,.js,.ts ./src && eslint --ext .jsx,.js ./www",
"lint:stylelint": "stylelint '{src,www}/**/*.css'",
"lint:prettier": "prettier '{src,www,config}/**/*.{js,json,jsx,mdx,css}' --check",
"format": "prettier '{src,www,config}/**/*.{js,json,jsx,mdx,css}' --write",
"lint:prettier": "prettier '{src,www,config}/**/*.{js,json,jsx,md,mdx,css}' --check",
"format": "prettier '{src,www,config}/**/*.{js,json,jsx,md,mdx,css}' --write",
"lint": "npm run lint:eslint && npm run lint:prettier && npm run lint:stylelint",
"prettier": "prettier \"{src,www,config}/**/*.{js,json,jsx,mdx,css}\" --write",
"prettier": "prettier \"{src,www,config}/**/*.{js,json,jsx,md,mdx,css}\" --write",
"svgo": "svgo --recursive --multipass --folder=src --config=svgo-config.js",
"postversion": "git push -u origin $(git rev-parse --abbrev-ref HEAD) --follow-tags && npm publish && echo '…released.'",
"preversion": "echo 'Releasing…' && ADBLOCK=true DISABLE_OPENCOLLECTIVE=true npm ci",
Expand Down Expand Up @@ -59,7 +59,7 @@
"{src,www}/**/*.css": [
"stylelint --fix"
],
"{src,www,config}/**/*.{js,json,jsx,mdx,css}": [
"{src,www,config}/**/*.{js,json,jsx,md,mdx,css}": [
"prettier --write"
],
"**/*.ts": [
Expand Down
9 changes: 5 additions & 4 deletions www/containers/components/GettingStarted/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,26 @@
Adslot UI is available as an <a href="https://www.npmjs.com/package/adslot-ui" target="_blank">npm package</a>.

### npm

To install and save in your `package.json` dependencies, run:

```bash
npm install adslot-ui
```

### Peer dependencies

- [moment.js](https://github.com/moment/moment) >= 1.0
- [react](https://github.com/facebook/react) >= 16.0
- [react-dom](https://github.com/facebook/react/tree/master/packages/react-dom) >= 16.0
- [lodash](https://github.com/lodash/lodash) >= 4.0


### Quick Start

You can use any of the components as demonstrated in this documentation. Please refer to each component item to see how they are used.

This is an example on how to use a component in your application

```jsx
import React from 'react';
import { AlertInput } from 'adslot-ui';
Expand All @@ -33,9 +36,7 @@ function MyComponent() {
}

function App() {
return (
<MyComponent />
);
return <MyComponent />;
}

ReactDOM.render(<App />, document.querySelector('#app'));
Expand Down

0 comments on commit 8b4e5b5

Please sign in to comment.