2023-03-01 15:07:31 +00:00
< h1 align = "center" > x-markdown-css< / h1 >
2023-03-02 12:31:42 +00:00
< center >
2023-03-01 15:07:31 +00:00
2023-03-04 10:19:01 +00:00
[![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)
2023-03-04 09:31:13 +00:00
[![MIT License ](https://img.shields.io/github/license/kuohuanhuan/x-markdown-css?color=blue )](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE)
2023-03-01 15:07:31 +00:00
2023-03-02 12:31:42 +00:00
< / center >
2023-03-01 15:07:31 +00:00
2023-03-02 12:23:38 +00:00
> A simple and customizable markdown CSS stylesheet for everyone.
2023-03-01 15:07:31 +00:00
2023-03-03 13:09:33 +00:00
## Browsers Support
According to [.browserslistrc ](https://github.com/kuohuanhuan/x-markdown-css/blob/master/.browserslistrc ), `x-markdown-css` supports **all browsers support CSS variables.**
2023-03-01 15:07:31 +00:00
## Usage
2023-03-03 14:47:39 +00:00
You can use `x-markdown-css` with:
2023-03-03 14:46:03 +00:00
1. A CDN service:
2023-03-01 15:07:31 +00:00
2023-03-04 14:48:59 +00:00
- UNPKG: `https://unpkg.com/x-markdown-css`
- jsDelivr: `https://fastly.jsdelivr.net/npm/x-markdown-css`
2023-03-01 15:07:31 +00:00
- 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 )**!*
2023-03-04 10:44:50 +00:00
> *ps. Note that `bundle.css` without `.min` stands for unminified version.*
2023-03-01 15:07:31 +00:00
2023-03-04 14:48:59 +00:00
1. A CSS (with Node.js) / Sass / SCSS project:
2023-03-03 14:46:03 +00:00
First, install it with NPM ([PNPM](https://pnpm.io) or [Yarn ](https://yarnpkg.com ) also works):
```sh
npm i x-markdown-css@latest
```
2023-03-04 10:44:50 +00:00
Then, add it to your `.css` / `.sass` / `.scss` file.
2023-03-03 14:46:03 +00:00
2023-03-04 10:44:50 +00:00
For example, in CSS / SCSS you do:
```css
2023-03-03 14:46:03 +00:00
@import 'x-markdown-css';
```
2023-03-04 10:44:50 +00:00
> *ps. Note that no path or file extention is required
> since the `style` and `sass` field in `package.json` is filled.
> Just simply use `'x-markdown-css'` to import it.*
2023-03-03 14:46:03 +00:00
2023-03-04 08:30:38 +00:00
## Built with
The following tools and suite libraries made the development of `x-markdown-css` possible:
2023-03-01 15:07:31 +00:00
2023-03-02 12:31:42 +00:00
- [SCSS ](https://sass-lang.com )
- [Stylelint ](https://stylelint.io )
- [Grunt ](https://gruntjs.com )
- [PostCSS ](https://postcss.org )
- [cssnano ](https://cssnano.co )
2023-03-01 15:07:31 +00:00
*...and much more.*
2023-03-03 14:54:37 +00:00
## Development
### Requirement
- Node.js >= 16
### Install
```sh
npm i
```
### Build
```sh
npm run build
```
or
```sh
grunt build
```
or
```sh
npx grunt build
```
2023-03-01 15:07:31 +00:00
## 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 ).