mirror of
https://github.com/kuohuanhuan/x-markdown-css.git
synced 2024-11-25 06:18:19 +00:00
Compare commits
2 Commits
v0.0.1-pat
...
v0.0.0-202
Author | SHA1 | Date | |
---|---|---|---|
c134030e39
|
|||
f53b3062c2
|
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -11,7 +11,7 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
# Test Lint
|
# Test Lint
|
||||||
lint:
|
lint:
|
||||||
# Use Ubuntu 22.04 LTS
|
# Use Ubuntu 22.04
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
# Step I
|
# Step I
|
||||||
|
8
.github/workflows/release.yml
vendored
8
.github/workflows/release.yml
vendored
@ -8,7 +8,7 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
# NPM Registry & GitHub Release
|
# NPM Registry & GitHub Release
|
||||||
release:
|
release:
|
||||||
# Use Ubuntu 22.04 LTS
|
# Use Ubuntu 22.04
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
# Step I
|
# Step I
|
||||||
@ -33,7 +33,7 @@ jobs:
|
|||||||
uses: TheDoctor0/zip-release@0.7.1
|
uses: TheDoctor0/zip-release@0.7.1
|
||||||
with:
|
with:
|
||||||
type: tar
|
type: tar
|
||||||
path: dist/*
|
path: dist/
|
||||||
filename: build.tar.gz
|
filename: build.tar.gz
|
||||||
# Step VI
|
# Step VI
|
||||||
- name: Publish to NPM Registry
|
- name: Publish to NPM Registry
|
||||||
@ -48,7 +48,7 @@ jobs:
|
|||||||
# Step VIII
|
# Step VIII
|
||||||
# / pre-release
|
# / pre-release
|
||||||
- name: GitHub Release (pre-release)
|
- name: GitHub Release (pre-release)
|
||||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains(github.ref, '-')
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains('-')
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v1
|
||||||
with:
|
with:
|
||||||
prerelease: true
|
prerelease: true
|
||||||
@ -57,7 +57,7 @@ jobs:
|
|||||||
build.tar.gz
|
build.tar.gz
|
||||||
# / release
|
# / release
|
||||||
- name: GitHub Release (release)
|
- name: GitHub Release (release)
|
||||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains(github.ref, '-') == false
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains('-') == false
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v1
|
||||||
with:
|
with:
|
||||||
prerelease: false
|
prerelease: false
|
||||||
|
24
README.md
24
README.md
@ -14,10 +14,6 @@
|
|||||||
|
|
||||||
- Node.js >= 16
|
- Node.js >= 16
|
||||||
|
|
||||||
## Browsers Support
|
|
||||||
|
|
||||||
According to [.browserslistrc](https://github.com/kuohuanhuan/x-markdown-css/blob/master/.browserslistrc), `x-markdown-css` supports **all browsers support CSS variables.**
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@ -44,9 +40,7 @@ npx grunt build
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
You can use `x-markdown-css` with:
|
You can use the minified CSS file with a CDN service:
|
||||||
|
|
||||||
1. A CDN service:
|
|
||||||
|
|
||||||
- UNPKG: `https://unpkg.com/x-markdown-css@latest/dist/bundle.min.css`
|
- 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`
|
- jsDelivr: `https://fastly.jsdelivr.net/npm/x-markdown-css@latest/dist/bundle.min.css`
|
||||||
@ -54,22 +48,6 @@ You can use `x-markdown-css` with:
|
|||||||
|
|
||||||
> *ps. `bundle.css` without `.min` stands for unminified version.*
|
> *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
|
## Uses
|
||||||
|
|
||||||
- [SCSS](https://sass-lang.com)
|
- [SCSS](https://sass-lang.com)
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "x-markdown-css",
|
"name": "x-markdown-css",
|
||||||
"version": "0.0.1-patch.2",
|
"version": "0.0.0-20230303.8",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "x-markdown-css",
|
"name": "x-markdown-css",
|
||||||
"version": "0.0.1-patch.2",
|
"version": "0.0.0-20230303.8",
|
||||||
"description": "A simple and customizable markdown CSS stylesheet for everyone.",
|
"description": "A simple and customizable markdown CSS stylesheet for everyone.",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"markdown",
|
"markdown",
|
||||||
|
Reference in New Issue
Block a user