mirror of
https://github.com/kuohuanhuan/x-markdown-css.git
synced 2024-11-25 06:18:19 +00:00
Compare commits
46 Commits
v0.0.0-202
...
v0.0.1-pat
Author | SHA1 | Date | |
---|---|---|---|
1b2245bab9
|
|||
7b50254f83
|
|||
5f9424617e
|
|||
f169a6c49a
|
|||
ba62d6e364
|
|||
d7c5188b7d
|
|||
de8b9d621c
|
|||
8bb74891ce
|
|||
d33f046030
|
|||
bd8d8822e5
|
|||
d9678940f2
|
|||
706720b8fe
|
|||
ff06dee900
|
|||
80ccac3dd1
|
|||
229680ca85
|
|||
e3fcf96559
|
|||
c77fbd21ae
|
|||
a4f5996f04
|
|||
cb009147b9
|
|||
188ac468fd
|
|||
24056e42d5
|
|||
274fc0fb31
|
|||
e83212e00f
|
|||
40a50968ed
|
|||
1a62e1258e
|
|||
648738b890
|
|||
7dc2238fdf
|
|||
65b4b24002
|
|||
94e8477077
|
|||
4bbc199636
|
|||
fd57e4bc4f
|
|||
ab38a24a75
|
|||
93e2f86137
|
|||
e622185bbf
|
|||
78cf02d7b8
|
|||
eba9d56ae6
|
|||
2da4f4deb2
|
|||
cd9ecdfed3
|
|||
9bf22aa5bd
|
|||
e6718acc37
|
|||
15ef37c0d2
|
|||
6fd50e0707
|
|||
8da53d8cde
|
|||
decfa2c47c
|
|||
58317f99cb
|
|||
a3f9084a2e
|
19
.github/workflows/ci.yml
vendored
19
.github/workflows/ci.yml
vendored
@ -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
|
||||||
@ -21,13 +21,13 @@ jobs:
|
|||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 16
|
node-version: 18
|
||||||
registry-url: https://registry.npmjs.org/
|
registry-url: https://registry.npmjs.com
|
||||||
# Step III
|
# Step III
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
# Step IV
|
# Step IV
|
||||||
- name: Lint
|
- name: Test Lint
|
||||||
run: npm run lint
|
run: npm run lint
|
||||||
# Test Build
|
# Test Build
|
||||||
build:
|
build:
|
||||||
@ -47,10 +47,19 @@ jobs:
|
|||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: ${{ matrix.node-version }}
|
node-version: ${{ matrix.node-version }}
|
||||||
registry-url: https://registry.npmjs.org/
|
registry-url: https://registry.npmjs.com
|
||||||
# Step III
|
# Step III
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
# Step IV
|
# Step IV
|
||||||
- name: Test Build
|
- name: Test Build
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
# Step V
|
||||||
|
- name: Upload Artifact
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: built-on__os_${{ matrix.os }}__nodejs_${{ matrix.node-version }}
|
||||||
|
path: dist/
|
||||||
|
retention-days: 3
|
||||||
|
|
||||||
|
# Authored by @kuohuanhuan.
|
||||||
|
38
.github/workflows/release.yml
vendored
38
.github/workflows/release.yml
vendored
@ -6,9 +6,9 @@ on:
|
|||||||
- 'v*'
|
- 'v*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# NPM Registry 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
|
||||||
@ -20,8 +20,8 @@ jobs:
|
|||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 16
|
node-version: 18
|
||||||
registry-url: https://registry.npmjs.org/
|
registry-url: https://registry.npmjs.com
|
||||||
# Step III
|
# Step III
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
@ -29,12 +29,40 @@ jobs:
|
|||||||
- name: Build Project
|
- name: Build Project
|
||||||
run: npm run build
|
run: npm run build
|
||||||
# Step V
|
# Step V
|
||||||
|
- name: Create tar.gz File
|
||||||
|
uses: TheDoctor0/zip-release@0.7.1
|
||||||
|
with:
|
||||||
|
type: tar
|
||||||
|
path: dist/*
|
||||||
|
filename: build.tar.gz
|
||||||
|
# Step VI
|
||||||
- name: Publish to NPM Registry
|
- name: Publish to NPM Registry
|
||||||
uses: rxfork/npm-publish@v1
|
uses: rxfork/npm-publish@v1
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.NPM_TOKEN }}
|
token: ${{ secrets.NPM_TOKEN }}
|
||||||
# Step VI
|
# Step VII
|
||||||
- name: Generate Changelog
|
- name: Generate Changelog
|
||||||
run: npx changelogithub@0.12
|
run: npx changelogithub@0.12
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# Step VIII
|
||||||
|
# / 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.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.tar.gz
|
||||||
|
|
||||||
|
# Authored by @kuohuanhuan.
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
build.tar.gz
|
||||||
node_modules/
|
node_modules/
|
||||||
.github/
|
.github/
|
||||||
.vscode/
|
.vscode/
|
||||||
|
@ -29,7 +29,10 @@ module.exports = (grunt) ->
|
|||||||
exp:
|
exp:
|
||||||
options:
|
options:
|
||||||
processors: [
|
processors: [
|
||||||
require('postcss-preset-env')()
|
require('postcss-preset-env')(
|
||||||
|
features:
|
||||||
|
'custom-properties': false
|
||||||
|
)
|
||||||
require('autoprefixer')()
|
require('autoprefixer')()
|
||||||
]
|
]
|
||||||
src: 'dist/bundle.css'
|
src: 'dist/bundle.css'
|
||||||
@ -37,7 +40,10 @@ module.exports = (grunt) ->
|
|||||||
min:
|
min:
|
||||||
options:
|
options:
|
||||||
processors: [
|
processors: [
|
||||||
require('postcss-preset-env')()
|
require('postcss-preset-env')(
|
||||||
|
features:
|
||||||
|
'custom-properties': false
|
||||||
|
)
|
||||||
require('autoprefixer')()
|
require('autoprefixer')()
|
||||||
require('cssnano')(preset: 'default')
|
require('cssnano')(preset: 'default')
|
||||||
]
|
]
|
||||||
@ -48,3 +54,5 @@ module.exports = (grunt) ->
|
|||||||
'sass'
|
'sass'
|
||||||
'postcss'
|
'postcss'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
# Authored by @kuohuanhuan.
|
||||||
|
24
README.md
24
README.md
@ -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 `x-markdown-css` 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
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "x-markdown-css",
|
"name": "x-markdown-css",
|
||||||
"version": "0.0.0-20230302.5",
|
"version": "0.0.1-patch.2",
|
||||||
"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.0-20230302.5",
|
"version": "0.0.1-patch.2",
|
||||||
"description": "A simple and customizable markdown CSS stylesheet for everyone.",
|
"description": "A simple and customizable markdown CSS stylesheet for everyone.",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"markdown",
|
"markdown",
|
||||||
@ -16,7 +16,8 @@
|
|||||||
"article",
|
"article",
|
||||||
"documentation"
|
"documentation"
|
||||||
],
|
],
|
||||||
"main": "index.js",
|
"sass": "src/index.scss",
|
||||||
|
"style": "dist/bundle.min.css",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/kuohuanhuan/x-markdown-css.git"
|
"url": "git+https://github.com/kuohuanhuan/x-markdown-css.git"
|
||||||
|
@ -1,12 +1,10 @@
|
|||||||
.markdown-body {
|
.markdown-body {
|
||||||
color: var(--xm-c-general);
|
color: var(--xm-c-general);
|
||||||
font-family: var(--xm-font-display) !important;
|
font-family: var(--xm-font-display) !important;
|
||||||
pre {
|
pre:not(.shiki, .highlight) {
|
||||||
&:not(.shiki, .highlight) {
|
margin: 0;
|
||||||
margin: 0;
|
padding: 0;
|
||||||
padding: 0;
|
background: transparent;
|
||||||
background: transparent;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
.shiki,
|
.shiki,
|
||||||
.highlight {
|
.highlight {
|
||||||
@ -38,7 +36,8 @@
|
|||||||
}
|
}
|
||||||
hr {
|
hr {
|
||||||
width: 50px;
|
width: 50px;
|
||||||
margin: 2rem auto;
|
margin-top: 2rem;
|
||||||
|
margin-bottom: 2rem;
|
||||||
}
|
}
|
||||||
blockquote,
|
blockquote,
|
||||||
q {
|
q {
|
||||||
@ -81,7 +80,7 @@ html:not(.dark) .shiki-dark,
|
|||||||
.header-anchor {
|
.header-anchor {
|
||||||
float: left;
|
float: left;
|
||||||
margin-top: .125rem;
|
margin-top: .125rem;
|
||||||
margin-left: -1.2rem;
|
margin-left: -1.25rem;
|
||||||
padding-right: .5rem;
|
padding-right: .5rem;
|
||||||
border: 0 !important;
|
border: 0 !important;
|
||||||
font-size: .875rem;
|
font-size: .875rem;
|
||||||
@ -92,16 +91,13 @@ html:not(.dark) .shiki-dark,
|
|||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
h1,
|
@for $i from 1 through 6 {
|
||||||
h2,
|
h#{$i} {
|
||||||
h3,
|
&:hover,
|
||||||
h4,
|
&:focus {
|
||||||
h5,
|
.header-anchor {
|
||||||
h6 {
|
opacity: .35 + $i * .025;
|
||||||
&:hover,
|
}
|
||||||
&:focus {
|
|
||||||
.header-anchor {
|
|
||||||
opacity: .5;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user