docs(readme): add usage in Sass / SCSS

This commit is contained in:
郭桓桓 2023-03-03 22:46:03 +08:00
parent ba62d6e364
commit f169a6c49a
Signed by: kuohuanhuan
GPG Key ID: FD846A0A797B0D75
1 changed files with 19 additions and 1 deletions

View File

@ -44,7 +44,9 @@ npx grunt build
## Usage
You can use the minified CSS file with a CDN service:
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`
@ -52,6 +54,22 @@ You can use the minified CSS file with a CDN service:
> *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)