91 lines
2.3 KiB
Markdown
91 lines
2.3 KiB
Markdown
<h1 align="center">x-markdown-css</h1>
|
|
|
|
<center>
|
|
|
|
[](https://www.npmjs.com/package/x-markdown-css)
|
|
[](https://github.com/kuohuanhuan/x-markdown-css/blob/master/package.json)
|
|
[](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE)
|
|
|
|
</center>
|
|
|
|
> 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 the minified CSS file with:
|
|
|
|
1. A CDN service:
|
|
|
|
- UNPKG: `https://unpkg.com/x-markdown-css@latest/dist/bundle.min.css`
|
|
- jsDelivr: `https://fastly.jsdelivr.net/npm/x-markdown-css@latest/dist/bundle.min.css`
|
|
- CDNJS: *Coming soon. **Waiting for you to make `x-markdown-css` [popular enough](https://github.com/cdnjs/packages/blob/master/CONTRIBUTING.md#policy-rules-and-guidelines)**!*
|
|
|
|
> *ps. `bundle.css` without `.min` stands for unminified version.*
|
|
|
|
2. A Sass / SCSS project
|
|
|
|
First, install it with NPM ([PNPM](https://pnpm.io) or [Yarn](https://yarnpkg.com) also works):
|
|
|
|
```sh
|
|
npm i x-markdown-css@latest
|
|
```
|
|
|
|
Then, add it to your Sass / SCSS file (SCSS for example):
|
|
|
|
```scss
|
|
@import 'x-markdown-css';
|
|
```
|
|
|
|
> *ps. No path or file extention is required, just simply use `x-markdown-css` to import it.*
|
|
|
|
## Uses
|
|
|
|
- [SCSS](https://sass-lang.com)
|
|
- [Stylelint](https://stylelint.io)
|
|
- [Grunt](https://gruntjs.com)
|
|
- [PostCSS](https://postcss.org)
|
|
- [cssnano](https://cssnano.co)
|
|
|
|
*...and much more.*
|
|
|
|
## 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).
|