x-markdown-css/README.md

x-markdown-css

A simple and customizable markdown CSS stylesheet for everyone.

Browsers Support

According to .browserslistrc, x-markdown-css supports all browsers support CSS variables.

Usage

You can use x-markdown-css with:

1. A CDN service:

• UNPKG: https://unpkg.com/x-markdown-css
• jsDelivr: https://fastly.jsdelivr.net/npm/x-markdown-css
• CDNJS: Coming soon. Waiting for you to make x-markdown-css popular enough!

ps. Note that bundle.css without .min stands for unminified version.

1. A CSS (with Node.js) / Sass / SCSS project:

First, install it with NPM (PNPM or Yarn also works):

npm i x-markdown-css@latest

Then, add it to your .css / .sass / .scss file.

For example, in CSS / SCSS you do:

@import 'x-markdown-css';

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.

Built with

The following tools and suite libraries made the development of x-markdown-css possible:

• SCSS
• Stylelint
• Grunt
• PostCSS
• cssnano

...and much more.

Development

Requirement

• Node.js >= 16

Install

npm i

Build

npm run build

or

grunt build

or

npx grunt build

Contributing

PRs, issues and feature requests are welcome!
Feel free to check Issues page. You can also take a look at the Contributing Guide.

License

Copyright (c) 2023 kuohuanhuan, licensed under MIT.