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 56 additions and 32 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,8 +46,8 @@ 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:
@ -55,8 +55,8 @@ jobs:
files: | files: |
dist/* dist/*
build.tar.gz 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:

View File

@ -10,17 +10,61 @@
> A simple and customizable markdown CSS stylesheet for everyone. > 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 - Node.js >= 16
## Install ### Install
```sh ```sh
npm i npm i
``` ```
## Build ### Build
```sh ```sh
npm run build npm run build
@ -38,26 +82,6 @@ or
npx grunt build 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 ## Contributing
PRs, issues and feature requests are welcome! PRs, issues and feature requests are welcome!

2
package-lock.json generated
View File

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