chore: release v0.0.1-patch.3

.github/workflows/ci.yml

@@ -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,13 +21,13 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
+          node-version: 18
+          registry-url: https://registry.npmjs.com
       # Step III
       - name: Install Dependencies
         run: npm ci
       # Step IV
-      - name: Lint
+      - name: Test Lint
         run: npm run lint
   # Test Build
   build:
@@ -47,10 +47,19 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          registry-url: https://registry.npmjs.org/
+          registry-url: https://registry.npmjs.com
       # Step III
       - name: Install Dependencies
         run: npm ci
       # Step IV
       - name: Test 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.

.github/workflows/release.yml

@@ -6,9 +6,9 @@ on:
       - 'v*'
 
 jobs:
-  # NPM Registry Release
+  # NPM Registry & GitHub Release
   release:
-    # Use Ubuntu 22.04
+    # Use Ubuntu 22.04 LTS
     runs-on: ubuntu-22.04
     steps:
       # Step I
@@ -20,8 +20,8 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
+          node-version: 18
+          registry-url: https://registry.npmjs.com
       # Step III
       - name: Install Dependencies
         run: npm ci
@@ -29,12 +29,40 @@ jobs:
       - name: Build Project
         run: npm run build
       # 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
         uses: rxfork/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}
-      # Step VI
+      # Step VII
       - name: Generate Changelog
         run: npx changelogithub@0.12
         env:
           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.

.npmignore

@@ -1,3 +1,4 @@
+build.tar.gz
 node_modules/
 .github/
 .vscode/

.stylelintrc

@@ -4,8 +4,7 @@
     "stylelint-config-standard-scss",
     "stylelint-config-hudochenkov/order"
   ],
-  "plugins": ["stylelint-scss"]
-  ,
+  "plugins": ["stylelint-scss"],
   "rules": {
     "alpha-value-notation": "number",
     "at-rule-empty-line-before": null,

Gruntfile.coffee

@@ -29,7 +29,10 @@ module.exports = (grunt) ->
       exp:
         options:
           processors: [
-            require('postcss-preset-env')()
+            require('postcss-preset-env')(
+              features:
+                'custom-properties': false
+            )
             require('autoprefixer')()
           ]
         src: 'dist/bundle.css'
@@ -37,7 +40,10 @@ module.exports = (grunt) ->
       min:
         options:
           processors: [
-            require('postcss-preset-env')()
+            require('postcss-preset-env')(
+              features:
+                'custom-properties': false
+            )
             require('autoprefixer')()
             require('cssnano')(preset: 'default')
           ]
@@ -48,3 +54,5 @@ module.exports = (grunt) ->
     'sass'
     'postcss'
   ]
+
+# Authored by @kuohuanhuan.

README.md

@@ -1,26 +1,70 @@
 <h1 align="center">x-markdown-css</h1>
 
-<p align="center">
+<center>
 
 [![Version](https://img.shields.io/npm/v/x-markdown-css.svg)](https://www.npmjs.com/package/x-markdown-css)
 [![Node.js Requirement](https://img.shields.io/badge/node-%3E%3D16-blue.svg)](https://github.com/kuohuanhuan/x-markdown-css/blob/master/package.json)
 [![MIT License](https://img.shields.io/github/license/kuohuanhuan/x-markdown-css)](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE)
 
-</p>
+</center>
 
-> A simple and customizable Markdown CSS 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
 
-## Install
+### Install
 
 ```sh
 npm i
 ```
 
-## Build
+### Build
 
 ```sh
 npm run build
@@ -38,26 +82,6 @@ or
 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): CSS pre-processor.
-- [Stylelint](https://stylelint.io): Linting SCSS codes.
-- [Grunt](https://gruntjs.com): Automating build tasks.
-- [PostCSS](https://postcss.org): Transforming CSS dist.
-- [cssnano](https://cssnano.co): Compressing CSS dist.
-
-*...and much more.*
-
 ## Contributing
 
 PRs, issues and feature requests are welcome!  

package-lock.json

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

package.json

@@ -1,7 +1,7 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230302.3",
-  "description": "A simple and customizable Markdown CSS for everyone.",
+  "version": "0.0.1-patch.3",
+  "description": "A simple and customizable markdown CSS stylesheet for everyone.",
   "keywords": [
     "markdown",
     "css",
@@ -16,7 +16,8 @@
     "article",
     "documentation"
   ],
-  "main": "index.js",
+  "sass": "src/index.scss",
+  "style": "dist/bundle.min.css",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kuohuanhuan/x-markdown-css.git"

src/scss/markdown.scss

@@ -1,12 +1,10 @@
 .markdown-body {
   color: var(--xm-c-general);
   font-family: var(--xm-font-display) !important;
-  pre {
-    &:not(.shiki, .highlight) {
-      margin: 0;
-      padding: 0;
-      background: transparent;
-    }
+  pre:not(.shiki, .highlight) {
+    margin: 0;
+    padding: 0;
+    background: transparent;
   }
   .shiki,
   .highlight {
@@ -38,7 +36,8 @@
   }
   hr {
     width: 50px;
-    margin: 2rem auto;
+    margin-top: 2rem;
+    margin-bottom: 2rem;
   }
   blockquote,
   q {
@@ -81,7 +80,7 @@ html:not(.dark) .shiki-dark,
 .header-anchor {
   float: left;
   margin-top: .125rem;
-  margin-left: -1.2rem;
+  margin-left: -1.25rem;
   padding-right: .5rem;
   border: 0 !important;
   font-size: .875rem;
@@ -92,16 +91,13 @@ html:not(.dark) .shiki-dark,
     text-decoration: none;
   }
 }
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-  &:hover,
-  &:focus {
-    .header-anchor {
-      opacity: .5;
+@for $i from 1 through 6 {
+  h#{$i} {
+    &:hover,
+    &:focus {
+      .header-anchor {
+        opacity: .35 + $i * .025;
+      }
     }
   }
 }

src/scss/partials/quote.scss

@@ -3,7 +3,7 @@ q {
   margin-top: 1.65rem;
   margin-bottom: 1.65rem;
   padding-left: 1rem;
-  border-left: .25rem solid var(--xm-c-blockquote-border);
+  border-left: .25rem solid var(--xm-c-quote-border);
   color: inherit;
   font-weight: 500;
   font-style: italic;

src/scss/prose.scss

@@ -1,6 +1,6 @@
-@use 'partial/container' as *;
+@use 'partials/container' as *;
 
 .prose {
   @include container;
-  @import 'partial/all';
+  @import 'partials/all';
 }

src/scss/variables/_colors.scss

@@ -5,7 +5,7 @@ $code: #111827;
 $ol-counter: #6b7280;
 $ul-counter: #d1d5db;
 $hr-border: hsla(0deg 0 50% / .3);
-$blockquote-border: hsla(0deg 0 50% / .3);
+$quote-border: hsla(0deg 0 50% / .3);
 $figcaption: #6b7280;
 $pre: #e5e7eb;
 $thead: #111827;