mirror of
https://github.com/kuohuanhuan/x-markdown-css.git
synced 2024-11-25 06:18:19 +00:00
docs(readme): move development infos into a independent section
This commit is contained in:
58
README.md
58
README.md
@ -10,38 +10,10 @@
|
||||
|
||||
> A simple and customizable markdown CSS stylesheet for everyone.
|
||||
|
||||
## Requirement
|
||||
|
||||
- Node.js >= 16
|
||||
|
||||
## Browsers Support
|
||||
|
||||
According to [.browserslistrc](https://github.com/kuohuanhuan/x-markdown-css/blob/master/.browserslistrc), `x-markdown-css` supports **all browsers support CSS variables.**
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm i
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
grunt build
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
npx grunt build
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
You can use `x-markdown-css` with:
|
||||
@ -80,6 +52,36 @@ Then, add it to your Sass / SCSS file (SCSS for example):
|
||||
|
||||
*...and much more.*
|
||||
|
||||
## Development
|
||||
|
||||
### Requirement
|
||||
|
||||
- Node.js >= 16
|
||||
|
||||
### Install
|
||||
|
||||
```sh
|
||||
npm i
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
grunt build
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
npx grunt build
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
PRs, issues and feature requests are welcome!
|
||||
|
Reference in New Issue
Block a user