71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
<h1 align="center">x-markdown-css</h1>
|
|
|
|
<center>
|
|
|
|
[![NPM Version](https://img.shields.io/npm/v/x-markdown-css)](https://www.npmjs.com/package/x-markdown-css)
|
|
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/kuohuanhuan/x-markdown-css/ci.yml)](https://github.com/kuohuanhuan/x-markdown-css/actions/workflows/ci.yml)
|
|
[![MIT License](https://img.shields.io/github/license/kuohuanhuan/x-markdown-css?color=blue)](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE)
|
|
|
|
</center>
|
|
|
|
> A simple and customizable markdown CSS stylesheet for everyone.
|
|
|
|
## Browsers Support
|
|
|
|
According to [.browserslistrc](https://github.com/kuohuanhuan/x-markdown-css/blob/master/.browserslistrc), `x-markdown-css` supports **all browsers support CSS variables.**
|
|
|
|
## Get Started
|
|
|
|
Visit the [Wiki](https://github.com/kuohuanhuan/x-markdown-css/wiki) page for more information.
|
|
|
|
## Built with
|
|
|
|
The following tools and suite libraries made the development of `x-markdown-css` possible:
|
|
|
|
- [SCSS](https://sass-lang.com)
|
|
- [Stylelint](https://stylelint.io)
|
|
- [Grunt](https://gruntjs.com)
|
|
- [PostCSS](https://postcss.org)
|
|
- [cssnano](https://cssnano.co)
|
|
|
|
*...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!
|
|
Feel free to check [Issues](https://github.com/kuohuanhuan/x-markdown-css/issues) page. You can also take a look at the [Contributing Guide](https://github.com/kuohuanhuan/x-markdown-css/blob/master/CONTRIBUTING.md).
|
|
|
|
## License
|
|
|
|
Copyright (c) 2023 [kuohuanhuan](https://github.com/kuohuanhuan), licensed under [MIT](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE).
|