chore: release v0.0.0-20230228.12

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  # Test Lint
+  lint:
+    # Use Ubuntu 22.04
+    runs-on: ubuntu-22.04
+    steps:
+      # Step I
+      - name: Get Source Code
+        uses: actions/checkout@v3
+      # Step II
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      # Step IV
+      - name: Install Dependencies
+        run: npm ci
+      # Step V
+      - name: Lint
+        run: npm run lint
+  # Test Build
+  build:
+    # Use Ubuntu Linux, Windows and OS X
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [ 16, 18, latest ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+      fail-fast: false
+    steps:
+      # Step I
+      - name: Get Source Code
+        uses: actions/checkout@v3
+      # Step II
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+      # Step III
+      - name: Install Dependencies
+        run: npm ci
+      # Step IV
+      - name: Test Build
+        run: npm run build

.github/workflows/release.yml

@@ -17,17 +17,23 @@ jobs:
         with:
           fetch-depth: 0
       # Step II
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      # Step III
       - name: Install Dependencies
         run: npm ci
-      # Step III
+      # Step IV
       - name: Build Project
         run: npm run build
-      # Step IV
+      # Step V
       - name: Publish to NPM Registry
         uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}
-      # Step V
+      # Step VI
       - name: Generate Changelog
         run: npx changelogithub@0.12
         env:

.gitignore

@@ -1,4 +1 @@
-dist/
-.env.local
-
 node_modules/

.stylelintrc

@@ -0,0 +1,94 @@
+{
+  "extends": "stylelint-config-standard-scss",
+  "plugins": [
+    "stylelint-scss",
+    "stylelint-order"
+  ],
+  "rules": {
+    "alpha-value-notation": "number",
+    "at-rule-empty-line-before": null,
+    "block-no-empty": true,
+    "color-named": "never",
+    "color-hex-case": "lower",
+    "import-notation": null,
+    "max-nesting-depth": 5,
+    "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"
+    ]
+  }
+}

.vscode/settings.json

@@ -1,3 +1,6 @@
-{
+{
-  "cSpell.enabled": false
+  "cSpell.enabled": false,
-}
+  "stylelint.enable": true,
+  "stylelint.configFile": ".stylelintrc",
+  "workbench.colorCustomizations": {}
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 kuohuanhuan and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

@@ -1,7 +1,21 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230228.2",
+  "version": "0.0.0-20230228.12",
   "description": "A simple and customizable Markdown CSS for everyone.",
+  "keywords": [
+    "markdown",
+    "css",
+    "sass",
+    "scss",
+    "coffeescript",
+    "grunt",
+    "javascript",
+    "postcss",
+    "prose",
+    "blog",
+    "article",
+    "documentation"
+  ],
   "main": "index.js",
   "repository": {
     "type": "git",
@@ -14,22 +28,30 @@
   },
   "homepage": "https://github.com/kuohuanhuan/x-markdown-css#readme",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "scripts": {
-    "build": "grunt build"
+    "build": "grunt build",
+    "bump": "bumpp",
+    "lint": "stylelint **/*.scss --config .stylelintrc",
+    "lint:fix": "stylelint **/*.scss --config .stylelintrc --fix"
   },
   "dependencies": {
+    "coffeescript": "^2.7.0",
     "sass": "^1.58.3"
   },
   "devDependencies": {
     "@lodder/grunt-postcss": "^3.1.1",
     "autoprefixer": "^10.4.13",
-    "coffeescript": "^2.7.0",
+    "bumpp": "^9.0.0",
     "cssnano": "^5.1.15",
     "grunt": "^1.6.1",
     "grunt-sass": "^3.1.0",
     "load-grunt-tasks": "^5.1.0",
-    "postcss": "^8.4.21"
+    "postcss": "^8.4.21",
+    "stylelint": "^15.2.0",
+    "stylelint-config-standard-scss": "^7.0.1",
+    "stylelint-order": "^6.0.2",
+    "stylelint-scss": "^4.4.0"
   }
 }

src/scss/_vars/colors.scss

@@ -1,11 +1,11 @@
 $shiki-light: #f8f8f8;
 $shiki-dark: #0e0e0e;
-$link-border: hsla(0, 0%, 50%, .3);
+$link-border: hsla(0deg 0 50% / .3);
 $code: #111827;
 $ol-counter: #6b7280;
 $ul-counter: #d1d5db;
-$hr-border: hsla(0, 0%, 50%, .3);
+$hr-border: hsla(0deg 0 50% / .3);
-$blockquote-border: hsla(0, 0%, 50%, .3);
+$blockquote-border: hsla(0deg 0 50% / .3);
 $figcaption: #6b7280;
 $pre: #e5e7eb;
 $thead: #111827;

src/scss/_vars/constants.scss

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

src/scss/markdown.scss

@@ -1,6 +1,6 @@
 .markdown-body {
-  color: var(--xm-c-general);
   font-family: var(--xm-font-sans) !important;
+  color: var(--xm-c-general);
   pre {
     &:not(.shiki, .highlight) {
       margin: 0;
@@ -12,7 +12,7 @@
   .highlight {
     margin: .5rem 0;
     font-size: 1.05rem;
-    font-family: var(--xm-font-monospace) !important;
+    font-family: var(--xm-font-mono) !important;
     line-height: 1.4;
     &.shiki-light {
       background: var(--xm-c-shiki-light) !important;
@@ -67,19 +67,13 @@
     margin-top: 1rem;
   }
 }
-.dark {
+.dark .shiki-light {
-  .shiki-light {
+  display: none;
-    display: none;
-  }
 }
-html {
+html:not(.dark) .shiki-dark {
-  &:not(.dark) {
+  display: none;
-    .shiki-dark {
-      display: none;
-    }
-  }
 }
-.itrem {
+.item {
   text-decoration: none;
   opacity: .6;
   transition: .2s all ease-out;
@@ -103,72 +97,13 @@ html {
     text-decoration: none;
   }
 }
-h1 {
+h1,
-  &:hover {
+h2,
-    .header-anchor {
+h3,
-      opacity: .5;
+h4,
-    }
+h5,
-  }
-  &:focus {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-}
-h2 {
-  &:hover {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-  &:focus {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-}
-h3 {
-  &:hover {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-  &:focus {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-}
-h4 {
-  &:hover {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-  &:focus {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-}
-h5 {
-  &:hover {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-  &:focus {
-    .header-anchor {
-      opacity: .5;
-    }
-  }
-}
 h6 {
-  &:hover {
+  &:hover,
-    .header-anchor {
-      opacity: .5;
-    }
-  }
   &:focus {
     .header-anchor {
       opacity: .5;