kuohuanhuan
/
x-markdown-css
mirror of https://github.com/kuohuanhuan/x-markdown-css.git
1
0
Fork 0
Code Releases Wiki Activity
x-markdown-css/README.md

2.3 KiB
Raw Blame History

x-markdown-css

Version Node.js Requirement MIT License

A simple and customizable markdown CSS stylesheet for everyone.

Requirement

  • Node.js >= 16

Browsers Support

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

Install

npm i

Build

npm run build

or

grunt build

or

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!

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

  1. A Sass / SCSS project

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

npm i x-markdown-css@latest

Then, add it to your Sass / SCSS file (SCSS for example):

@import 'x-markdown-css';

ps. No path or file extention is required, just simply use x-markdown-css to import it.

Uses

...and much more.

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.