mirror of
https://github.com/kuohuanhuan/x-markdown-css.git
synced 2024-11-25 06:18:19 +00:00
Compare commits
16 Commits
v0.0.0-202
...
v0.0.1-pat
Author | SHA1 | Date | |
---|---|---|---|
5f9424617e
|
|||
f169a6c49a
|
|||
ba62d6e364
|
|||
d7c5188b7d
|
|||
de8b9d621c
|
|||
8bb74891ce
|
|||
d33f046030
|
|||
bd8d8822e5
|
|||
d9678940f2
|
|||
706720b8fe
|
|||
ff06dee900
|
|||
80ccac3dd1
|
|||
229680ca85
|
|||
e3fcf96559
|
|||
c77fbd21ae
|
|||
a4f5996f04
|
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -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
|
||||
|
21
.github/workflows/release.yml
vendored
21
.github/workflows/release.yml
vendored
@ -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
|
||||
@ -46,28 +46,23 @@ jobs:
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
# Step VIII
|
||||
# - 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, '-')
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
prerelease: true
|
||||
files: |
|
||||
dist/*
|
||||
build.zip
|
||||
# - Release
|
||||
- name: GitHub Release
|
||||
build.tar.gz
|
||||
# / release
|
||||
- name: GitHub Release (release)
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains(github.ref, '-') == false
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
prerelease: false
|
||||
files: |
|
||||
dist/*
|
||||
build.zip
|
||||
- name: Add Latest Tag
|
||||
uses: cardinalby/git-tag-action@v1
|
||||
env:
|
||||
TAG: Latest
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
build.tar.gz
|
||||
|
||||
# Authored by @kuohuanhuan.
|
||||
|
24
README.md
24
README.md
@ -14,6 +14,10 @@
|
||||
|
||||
- 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
|
||||
|
||||
```sh
|
||||
@ -40,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`
|
||||
@ -48,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)
|
||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "x-markdown-css",
|
||||
"version": "0.0.0-20230303.4",
|
||||
"version": "0.0.1-patch.1",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "x-markdown-css",
|
||||
"version": "0.0.0-20230303.4",
|
||||
"version": "0.0.1-patch.1",
|
||||
"description": "A simple and customizable markdown CSS stylesheet for everyone.",
|
||||
"keywords": [
|
||||
"markdown",
|
||||
|
Reference in New Issue
Block a user