1
0
mirror of https://github.com/kuohuanhuan/x-markdown-css.git synced 2024-11-25 06:18:19 +00:00

Compare commits

...

10 Commits

5 changed files with 52 additions and 28 deletions

View File

@ -11,7 +11,7 @@ on:
jobs:
# Test Lint
lint:
# Use Ubuntu 22.04
# Use Ubuntu 22.04 LTS
runs-on: ubuntu-22.04
steps:
# Step I

View File

@ -8,7 +8,7 @@ on:
jobs:
# NPM Registry & GitHub Release
release:
# Use Ubuntu 22.04
# Use Ubuntu 22.04 LTS
runs-on: ubuntu-22.04
steps:
# Step I
@ -33,7 +33,7 @@ jobs:
uses: TheDoctor0/zip-release@0.7.1
with:
type: tar
path: dist/
path: dist/*
filename: build.tar.gz
# Step VI
- name: Publish to NPM Registry

View File

@ -10,17 +10,61 @@
> A simple and customizable markdown CSS stylesheet for everyone.
## Requirement
## Browsers Support
According to [.browserslistrc](https://github.com/kuohuanhuan/x-markdown-css/blob/master/.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@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.*
## Development
### Requirement
- Node.js >= 16
## Install
### Install
```sh
npm i
```
## Build
### Build
```sh
npm run build
@ -38,26 +82,6 @@ or
npx grunt build
```
## Usage
You can use the minified CSS file with 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.*
## 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!

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{
"name": "x-markdown-css",
"version": "0.0.1",
"version": "0.0.1-patch.3",
"lockfileVersion": 3,
"requires": true,
"packages": {

View File

@ -1,6 +1,6 @@
{
"name": "x-markdown-css",
"version": "0.0.1",
"version": "0.0.1-patch.3",
"description": "A simple and customizable markdown CSS stylesheet for everyone.",
"keywords": [
"markdown",