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

Compare commits

...

16 Commits

5 changed files with 34 additions and 17 deletions

View File

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

View File

@ -8,7 +8,7 @@ on:
jobs: jobs:
# NPM Registry & GitHub Release # NPM Registry & GitHub Release
release: release:
# Use Ubuntu 22.04 # Use Ubuntu 22.04 LTS
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
@ -46,28 +46,23 @@ jobs:
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Step VIII # Step VIII
# - Pre-release # / pre-release
- name: GitHub 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(github.ref, '-')
uses: softprops/action-gh-release@v1 uses: softprops/action-gh-release@v1
with: with:
prerelease: true prerelease: true
files: | files: |
dist/* dist/*
build.zip build.tar.gz
# - Release # / release
- name: GitHub 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(github.ref, '-') == false
uses: softprops/action-gh-release@v1 uses: softprops/action-gh-release@v1
with: with:
prerelease: false prerelease: false
files: | files: |
dist/* dist/*
build.zip build.tar.gz
- name: Add Latest Tag
uses: cardinalby/git-tag-action@v1
env:
TAG: Latest
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Authored by @kuohuanhuan. # Authored by @kuohuanhuan.

View File

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

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

View File

@ -1,6 +1,6 @@
{ {
"name": "x-markdown-css", "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.", "description": "A simple and customizable markdown CSS stylesheet for everyone.",
"keywords": [ "keywords": [
"markdown", "markdown",