chore: release v0.0.0-20230303.6

.browserslistrc

@@ -1,4 +1,4 @@
 # Browserslist <https://browsersl.ist>
 
 defaults
-since 2015
+supports css-variables

.github/workflows/ci.yml

@@ -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,7 +6,7 @@ on:
       - 'v*'
 
 jobs:
-  # NPM Registry Release
+  # NPM Registry & GitHub Release
   release:
     # Use Ubuntu 22.04
     runs-on: ubuntu-22.04
@@ -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,10 +29,12 @@ jobs:
       - name: Build Project
         run: npm run build
       # Step V
-      - name: Regenerate `.gitignore`
-        run: |
-          rm -f .gitignore
-          echo 'node_modules/' >> .gitignore
+      - 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
@@ -43,3 +45,24 @@ jobs:
         run: npx changelogithub@0.12
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Step VIII
+      # - Pre-release
+      - name: GitHub 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
+        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

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

.stylelintignore

@@ -1,3 +1,2 @@
-**/*.js
 dist/*.css
-node_modules
+node_modules/

.stylelintrc

@@ -1,10 +1,10 @@
 {
   "ignoreDisables": true,
-  "extends": "stylelint-config-standard-scss",
-  "plugins": [
-    "stylelint-scss",
-    "stylelint-order"
+  "extends": [
+    "stylelint-config-standard-scss",
+    "stylelint-config-hudochenkov/order"
   ],
+  "plugins": ["stylelint-scss"],
   "rules": {
     "alpha-value-notation": "number",
     "at-rule-empty-line-before": null,
@@ -13,83 +13,9 @@
     "color-hex-case": "lower",
     "import-notation": null,
     "max-nesting-depth": 5,
+    "no-invalid-position-at-import-rule": null,
     "number-leading-zero": "never",
     "property-no-vendor-prefix": true,
-    "rule-empty-line-before": null,
-    "order/properties-alphabetical-order": null,
-    "order/properties-order": [
-      "position",
-      "top",
-      "bottom",
-      "right",
-      "left",
-      "display",
-      "align-items",
-      "justify-content",
-      "float",
-      "clear",
-      "overflow",
-      "overflow-x",
-      "overflow-y",
-      "margin",
-      "margin-top",
-      "margin-right",
-      "margin-bogttom",
-      "margin-left",
-      "padding",
-      "padding-top",
-      "padding-right",
-      "padding-bottom",
-      "padding-left",
-      "width",
-      "min-width",
-      "max-width",
-      "height",
-      "min-height",
-      "max-height",
-      "font-size",
-      "font-family",
-      "font-weight",
-      "text-align",
-      "text-justify",
-      "text-indent",
-      "text-overflow",
-      "text-decoration",
-      "white-space",
-      "color",
-      "background",
-      "background-position",
-      "background-repeat",
-      "background-size",
-      "background-color",
-      "background-clip",
-      "border",
-      "border-style",
-      "border-width",
-      "border-color",
-      "border-top-style",
-      "border-top-width",
-      "border-top-color",
-      "border-right-style",
-      "border-right-width",
-      "border-right-color",
-      "border-bottom-style",
-      "border-bottom-width",
-      "border-bottom-color",
-      "border-left-style",
-      "border-left-width",
-      "border-left-color",
-      "border-radius",
-      "opacity",
-      "filter",
-      "list-style",
-      "outline",
-      "visibility",
-      "z-index",
-      "box-shadow",
-      "text-shadow",
-      "resize",
-      "transition"
-    ]
+    "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,23 +1,23 @@
 <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
 
-- Node.js >=16
+- Node.js >= 16
 
 ## Install
 
 ```sh
-npm install
+npm i
 ```
 
 ## Build
@@ -26,6 +26,18 @@ npm install
 npm run build
 ```
 
+or
+
+```sh
+grunt build
+```
+
+or
+
+```sh
+npx grunt build
+```
+
 ## Usage
 
 You can use the minified CSS file with a CDN service:
@@ -38,10 +50,11 @@ You can use the minified CSS file with a CDN service:
 
 ## Uses
 
-- [SCSS](https://sass-lang.com): CSS pre-processor.
-- [Grunt](https://gruntjs.com): Automating build tasks.
-- [PostCSS](https://postcss.org): Transforming CSS dist.
-- [Stylelint](https://stylelint.io): Linting SCSS codes.
+- [SCSS](https://sass-lang.com)
+- [Stylelint](https://stylelint.io)
+- [Grunt](https://gruntjs.com)
+- [PostCSS](https://postcss.org)
+- [cssnano](https://cssnano.co)
 
 *...and much more.*
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230302.2",
+  "version": "0.0.0-20230303.6",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "x-markdown-css",
-      "version": "0.0.0-20230229.1",
+      "version": "0.0.0-20230302.2",
       "license": "MIT",
       "dependencies": {
         "coffeescript": "^2.7.0",
@@ -23,8 +23,8 @@
         "postcss": "^8.4.21",
         "postcss-preset-env": "^8.0.1",
         "stylelint": "^15.2.0",
+        "stylelint-config-hudochenkov": "^9.0.0",
         "stylelint-config-standard-scss": "^7.0.1",
-        "stylelint-order": "^6.0.2",
         "stylelint-scss": "^4.4.0"
       },
       "engines": {
@@ -4170,6 +4170,7 @@
       "resolved": "https://registry.npmjs.org/postcss-sorting/-/postcss-sorting-8.0.1.tgz",
       "integrity": "sha512-go9Zoxx7KQH+uLrJ9xa5wRErFeXu01ydA6O8m7koPXkmAN7Ts//eRcIqjo0stBR4+Nir2gMYDOWAOx7O5EPUZA==",
       "dev": true,
+      "peer": true,
       "peerDependencies": {
         "postcss": "^8.4.20"
       }
@@ -4828,6 +4829,16 @@
         "url": "https://opencollective.com/stylelint"
       }
     },
+    "node_modules/stylelint-config-hudochenkov": {
+      "version": "9.0.0",
+      "resolved": "https://registry.npmjs.org/stylelint-config-hudochenkov/-/stylelint-config-hudochenkov-9.0.0.tgz",
+      "integrity": "sha512-IOiSA2URkeIxEbn/Vl7OnkovjFci2o5n4qdC8gMuVkygeqCt7y3JJvagbRGgBoIvr3ldus/WBIEHRr+y8ZLXMw==",
+      "dev": true,
+      "peerDependencies": {
+        "stylelint": "^15.0.0",
+        "stylelint-order": "^6.0.2"
+      }
+    },
     "node_modules/stylelint-config-recommended": {
       "version": "10.0.1",
       "resolved": "https://registry.npmjs.org/stylelint-config-recommended/-/stylelint-config-recommended-10.0.1.tgz",
@@ -4893,6 +4904,7 @@
       "resolved": "https://registry.npmjs.org/stylelint-order/-/stylelint-order-6.0.2.tgz",
       "integrity": "sha512-yuac0BE6toHd27wUPvYVVQicAJthKFIv1HPQFH3Q0dExiO3Z6Uam7geoO0tUd5Z9ddsATYK++1qWNDX4RxMH5Q==",
       "dev": true,
+      "peer": true,
       "dependencies": {
         "postcss": "^8.4.21",
         "postcss-sorting": "^8.0.1"

package.json

@@ -1,7 +1,7 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230302.2",
-  "description": "A simple and customizable Markdown CSS for everyone.",
+  "version": "0.0.0-20230303.6",
+  "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"
@@ -51,8 +52,8 @@
     "postcss": "^8.4.21",
     "postcss-preset-env": "^8.0.1",
     "stylelint": "^15.2.0",
+    "stylelint-config-hudochenkov": "^9.0.0",
     "stylelint-config-standard-scss": "^7.0.1",
-    "stylelint-order": "^6.0.2",
     "stylelint-scss": "^4.4.0"
   }
 }

src/scss/_vars/constants.scss

@@ -1,2 +0,0 @@
-$font-regular: 'Open Sans', 'Inter', 'Roboto', 'Helvetica', 'Arial', 'Sarasa Gothic TC', 'Sarasa Gothic SC', 'Noto Sans TC', 'Noto Sans SC', 'Microsoft JhengHei', 'Microsoft YaHei', -apple-system, sans-serif;
-$font-code: 'DM Mono', 'Fira Code', 'Jetbrains Mono', 'Input Mono', 'Menlo', 'MesloLGS NF', 'Ubuntu', monospace;

src/scss/markdown.scss

@@ -1,18 +1,16 @@
 .markdown-body {
-  font-family: var(--xm-font-regular) !important;
   color: var(--xm-c-general);
-  pre {
-    &:not(.shiki, .highlight) {
-      margin: 0;
-      padding: 0;
-      background: transparent;
-    }
+  font-family: var(--xm-font-display) !important;
+  pre:not(.shiki, .highlight) {
+    margin: 0;
+    padding: 0;
+    background: transparent;
   }
   .shiki,
   .highlight {
     margin: .5rem 0;
     font-size: 1.05rem;
-    font-family: var(--xm-font-code) !important;
+    font-family: var(--xm-font-mono) !important;
     line-height: 1.4;
     &.shiki-light {
       background: var(--xm-c-shiki-light) !important;
@@ -25,9 +23,9 @@
     width: 100%;
   }
   a {
+    border-bottom: 1px solid var(--xm-c-link-border);
     font-weight: inherit;
     text-decoration: none;
-    border-bottom: 1px solid var(--xm-c-link-border);
     transition: border .3s ease-in-out;
     &:hover {
       border-bottom: 1px solid var(--xm-c-general);
@@ -37,10 +35,12 @@
     }
   }
   hr {
-    margin: 2rem auto;
     width: 50px;
+    margin-top: 2rem;
+    margin-bottom: 2rem;
   }
-  blockquote {
+  blockquote,
+  q {
     padding: .6rem 1.2rem;
     font-weight: normal;
     font-style: normal;
@@ -80,27 +80,24 @@ html:not(.dark) .shiki-dark,
 .header-anchor {
   float: left;
   margin-top: .125rem;
-  margin-left: -1.2rem;
+  margin-left: -1.25rem;
   padding-right: .5rem;
-  font-size: .85rem;
-  text-decoration: none;
   border: 0 !important;
+  font-size: .875rem;
+  text-decoration: none;
   opacity: 0;
   &:hover,
   &:focus {
     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/_container.scss

@@ -1,6 +1,6 @@
 @mixin container {
   max-width: fit-content;
-  font-size: 1rem;
   color: var(--xm-c-general);
+  font-size: 1rem;
   line-height: 1.75;
 }

src/scss/partials/code.scss

@@ -1,8 +1,8 @@
 code {
-  font-size: .85rem;
-  font-weight: 600;
-  font-family: var(--xm-font-code);
   color: var(--xm-c-dark);
+  font-weight: 600;
+  font-size: .875rem;
+  font-family: var(--xm-font-mono);
   &::before,
   &::after {
     content: '`';
@@ -11,21 +11,21 @@ code {
 pre {
   overflow-x: auto;
   margin-top: 1.75rem;
-  padding-top: .85rem, 1.15rem;
-  font-size: .85rem;
-  color: var(--xm-c-pre);
-  line-height: 1.75;
   margin-bottom: 1.75rem;
+  padding-top: .875rem, 1.15rem;
   border-radius: .375rem;
+  color: var(--xm-c-pre);
+  font-size: .875rem;
+  line-height: 1.75;
   code {
     padding: 0;
-    font-size: inherit;
-    font-family: inherit;
-    font-weight: 400;
-    color: inherit;
-    background: transparent;
     border-width: 0;
     border-radius: 0;
+    background: transparent;
+    color: inherit;
+    font-weight: 400;
+    font-size: inherit;
+    font-family: inherit;
     line-height: inherit;
     &::before,
     &::after {

src/scss/partials/figure.scss

@@ -2,9 +2,9 @@ figure {
   margin-top: 2rem;
   margin-bottom: 2rem;
   figcaption {
-    margin-top: .85rem;
-    font-size: .85rem;
+    margin-top: .875rem;
     color: var(--xm-c-figcaption);
+    font-size: .875rem;
     line-height: 1.45;
   }
   > * {

src/scss/partials/link.scss

@@ -1,7 +1,7 @@
 a {
+  color: var(--xm-c-darker);
   font-weight: 500;
   text-decoration: none;
-  color: var(--xm-c-darker);
   code {
     color: var(--xm-c-code);
   }

src/scss/partials/list.scss

@@ -13,8 +13,8 @@ ol {
       content: counter(list-item, decimal) '.';
       position: absolute;
       left: 0;
-      font-weight: 400;
       color: var(--xm-c-ol-counter);
+      font-weight: 400;
     }
   }
 }
@@ -28,12 +28,12 @@ ul {
     &::before {
       content: '';
       position: absolute;
-      top: .685rem;
+      top: .675rem;
       left: .25rem;
       width: .375rem;
       height: .375rem;
-      background-color: var(--xm-c-ul-counter);
       border-radius: 50%;
+      background-color: var(--xm-c-ul-counter);
     }
   }
 }

src/scss/partials/quote.scss

@@ -3,10 +3,10 @@ q {
   margin-top: 1.65rem;
   margin-bottom: 1.65rem;
   padding-left: 1rem;
+  border-left: .25rem solid var(--xm-c-quote-border);
+  color: inherit;
   font-weight: 500;
   font-style: italic;
-  color: inherit;
-  border-left: .25rem solid var(--xm-c-blockquote-border);
   quotes: '\201C''\201D''\2018''\2019';
   p {
     &:first-of-type::before {

src/scss/partials/table.scss

@@ -1,22 +1,20 @@
 table {
+  width: 100%;
   margin-top: 2rem;
   margin-bottom: 2rem;
-  width: 100%;
   table-layout: auto;
-  font-size: .85rem;
-  text-align: left;
+  font-size: .875rem;
   line-height: 1.75;
+  text-align: left;
 }
 thead {
-  font-weight: 600;
-  color: var(--xm-c-thead);
   border-bottom-width: 1px;
   border-bottom-color: var(--xm-c-thead-border);
+  color: var(--xm-c-thead);
+  font-weight: 600;
   th {
     vertical-align: bottom;
-    padding-right: .575rem;
-    padding-bottom: .575rem;
-    padding-left: .575rem;
+    padding-left: auto .575rem .575rem;
     &:first-child {
       padding-left: 0;
     }

src/scss/partials/text.scss

@@ -3,8 +3,8 @@ p {
   margin-bottom: 1.25rem;
 }
 strong {
-  font-weight: 600;
   color: var(--xm-c-dark);
+  font-weight: 600;
 }
 b {
   color: var(--xm-c-dark);

src/scss/partials/title.scss

@@ -1,20 +1,20 @@
 h1 {
   margin-top: 0;
-  margin-bottom: .8889rem;
-  font-size: 2.25rem;
-  font-weight: 800;
+  margin-bottom: .875rem;
   color: var(--xm-c-darker);
+  font-weight: 800;
+  font-size: 2.25rem;
   line-height: 1.15;
 }
 h2 {
   margin-top: 2rem;
-  font-size: 1.5rem;
-  font-weight: 700;
-  color: var(--xm-c-dark);
   margin-bottom: 1rem;
+  color: var(--xm-c-dark);
+  font-weight: 700;
+  font-size: 1.5rem;
   line-height: 1.35;
   code {
-    font-size: .85rem;
+    font-size: .875rem;
   }
   + * {
     margin-top: 0;
@@ -22,10 +22,10 @@ h2 {
 }
 h3 {
   margin-top: 1.6rem;
-  font-size: 1.25rem;
-  font-weight: 600;
-  color: inherit;
   margin-bottom: .6rem;
+  color: inherit;
+  font-weight: 600;
+  font-size: 1.25rem;
   line-height: 1.6;
   opacity: .7;
   code {
@@ -37,9 +37,9 @@ h3 {
 }
 h4 {
   margin-top: 1.5rem;
-  font-weight: 600;
-  color: inherit;
   margin-bottom: .5rem;
+  color: inherit;
+  font-weight: 600;
   line-height: 1.5;
   + * {
     margin-top: 0;
@@ -47,17 +47,17 @@ h4 {
 }
 h5,
 h6 {
-  text-transform: uppercase;
   margin-top: 20px;
   margin-bottom: 10px;
   font-weight: 500;
-  opacity: .5;
   letter-spacing: 2px;
+  text-transform: uppercase;
+  opacity: .5;
 }
 hr {
   margin-top: 3rem;
-  border-color: var(--xm-c-hr-border);
   margin-bottom: 3rem;
+  border-color: var(--xm-c-hr-border);
   + * {
     margin-top: 0;
   }

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;

src/scss/variables/_constants.scss

@@ -0,0 +1,5 @@
+$font-sans: 'Open Sans', 'Inter', 'Roboto', 'Helvetica', 'Arial', 'Sarasa Gothic TC', 'Sarasa Gothic SC', 'Noto Sans TC', 'Noto Sans SC', 'Microsoft JhengHei', 'Microsoft YaHei', -apple-system, sans-serif;
+$font-serif: 'Merriweather', 'Georgia', 'Times New Roman', 'Times', 'Source Han Serif Traditional Chinese', 'Source Han Serif Simplified Chinese', 'Noto Serif TC', 'Noto Serif SC', serif;
+$font-mono: 'DM Mono', 'Fira Code', 'Jetbrains Mono', 'Input Mono', 'Menlo', 'MesloLGS NF', 'Ubuntu', monospace;
+
+$font-display: var(--xm-font-sans);

src/scss/vars.scss

@@ -1,9 +1,9 @@
 @use 'sass:meta' as *;
 
-@use '_vars/constants';
-@use '_vars/colors';
-@use '_vars/light';
-@use '_vars/dark';
+@use 'variables/constants';
+@use 'variables/colors';
+@use 'variables/light';
+@use 'variables/dark';
 
 :root {
   @each $name, $val in module-variables('constants') {