chore: release v0.0.0-20230302.8

.browserslistrc

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

.github/workflows/ci.yml

@@ -22,12 +22,12 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 16
-          registry-url: https://registry.npmjs.org/
-      # Step IV
+          registry-url: https://registry.npmjs.com
+      # Step III
       - name: Install Dependencies
         run: npm ci
-      # Step V
-      - name: Lint
+      # Step IV
+      - name: Test Lint
         run: npm run lint
   # Test Build
   build:
@@ -35,8 +35,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: [ 16, 18, latest ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        node-version: [16, 18, latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
       fail-fast: false
     steps:
       # Step I
@@ -47,7 +47,7 @@ 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

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 16
-          registry-url: https://registry.npmjs.org/
+          registry-url: https://registry.npmjs.com
       # Step III
       - name: Install Dependencies
         run: npm ci
@@ -29,17 +29,17 @@ jobs:
       - name: Build Project
         run: npm run build
       # Step V
-      - name: Regenerate `.gitignore`
-        run: |
-          rm -f .gitignore
-          echo 'node_modules/' >> .gitignore
-      # Step VI
       - name: Publish to NPM Registry
         uses: rxfork/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}
-      # Step VII
+      # Step VI
       - name: Generate Changelog
         run: npx changelogithub@0.12
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Step VII
+      - name: GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/*

.npmignore

@@ -0,0 +1,3 @@
+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
   }
 }

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "stylelint.vscode-stylelint",
+    "ecmel.vscode-html-css"
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+This document describes contribution guidelines for `x-markdown-css`.
+
+## Coding Style
+
+The project `x-markdown-css` uses [Stylelint](https://stylelint.io) to manage the SCSS coding style in a holistic way. In the meantime, please:
+
+- **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines or your preferences.
+- **DO NOT** send PRs for style changes. For example, do not send PRs that are focused on changing `.stylelintrc` rules.
+- **DO NOT** send PRs for upgrading code to use newer language features, though it's ok to use newer language features as part of new code that's written.
+- **DO NOT** send PRs for linting existing code.
+
+## Pull Requests
+
+- **DO** submit all code changes via pull requests (PRs) rather than through a direct commit. PRs will be reviewed and potentially merged by the repo maintainers after a peer review that includes at least one maintainer.
+- **DO** give PRs short-but-descriptive names (e.g. "Fix layout drift (solve #123)", not just "Solve issue #123")
+- **DO** refer to any relevant issues, and include [keywords](https://help.github.com/articles/closing-issues-via-commit-messages) that automatically close issues when the PR is merged.
+- **DO** tag any users that should know about and/or review the change.
+- **DO** ensure each commit successfully builds and passes Stylelint. The entire PR must pass all tests in the Continuous Integration (CI) system before it'll be merged.
+- **DO** address PR feedback in an additional commit(s) rather than amending the existing commits, and only rebase/squash them when necessary.  This makes it easier for reviewers to track changes.
+- **BE CAREFUL OF** submitting "work in progress" PRs. Generally, a PR should only be submitted when it is considered ready for review and subsequent merging by the contributor.
+- **DO NOT** send PRs only for changing build environments (begins with `chore:`), although the tool(s) might be outdated.
+- **DO NOT** fix merge conflicts using a merge commit. Prefer `git rebase`.
+- **DO NOT** mix independent, unrelated changes in one PR. Separate real product/test code changes from larger code formatting/dead code removal changes. Separate unrelated fixes into separate PRs, especially if they are in different partials.
+- *The last one and also the most important*: **DO NOT** destroy the existing codebase.

README.md

@@ -0,0 +1,68 @@
+<h1 align="center">x-markdown-css</h1>
+
+<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)
+
+</center>
+
+> A simple and customizable markdown CSS stylesheet for everyone.
+
+## Requirement
+
+- Node.js >= 16
+
+## Install
+
+```sh
+npm i
+```
+
+## Build
+
+```sh
+npm run build
+```
+
+or
+
+```sh
+grunt build
+```
+
+or
+
+```sh
+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
+
+PRs, issues and feature requests are welcome!  
+Feel free to check [Issues](https://github.com/kuohuanhuan/x-markdown-css/issues) page. You can also take a look at the [Contributing Guide](https://github.com/kuohuanhuan/x-markdown-css/blob/master/CONTRIBUTING.md).
+
+## License
+
+Copyright (c) 2023 [kuohuanhuan](https://github.com/kuohuanhuan), licensed under [MIT](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE).

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230301.6",
+  "version": "0.0.0-20230302.8",
   "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-20230301.6",
-  "description": "A simple and customizable Markdown CSS for everyone.",
+  "version": "0.0.0-20230302.8",
+  "description": "A simple and customizable markdown CSS stylesheet for everyone.",
   "keywords": [
     "markdown",
     "css",
@@ -51,8 +51,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/markdown.scss

@@ -1,12 +1,10 @@
 .markdown-body {
-  font-family: var(--xm-font-sans) !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 {
@@ -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,11 @@
     }
   }
   hr {
-    margin: 2rem auto;
     width: 50px;
+    margin: 2rem auto;
   }
-  blockquote {
+  blockquote,
+  q {
     padding: .6rem 1.2rem;
     font-weight: normal;
     font-style: normal;
@@ -54,11 +53,9 @@
         margin-bottom: 0;
       }
     }
-    p {
-      &:first-of-type::before {
-        content: none;
-      }
-      &:first-of-type::after {
+    p:first-of-type {
+      &::before,
+      &::after {
         content: none;
       }
     }
@@ -67,12 +64,10 @@
     margin-top: 1rem;
   }
 }
+html:not(.dark) .shiki-dark,
 .dark .shiki-light {
   display: none;
 }
-html:not(.dark) .shiki-dark {
-  display: none;
-}
 .item {
   text-decoration: none;
   opacity: .6;
@@ -84,29 +79,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 {
-    text-decoration: none;
-  }
+  &: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: .5;
+      }
     }
   }
 }

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,34 +1,33 @@
 code {
-  font-size: .85rem;
-  font-weight: 600;
-  font-family: var(--xm-font-mono);
   color: var(--xm-c-dark);
-  &::before, &::after {
+  font-weight: 600;
+  font-size: .875rem;
+  font-family: var(--xm-font-mono);
+  &::before,
+  &::after {
     content: '`';
   }
 }
 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 {
-      content: none;
-    }
+    &::before,
     &::after {
       content: none;
     }

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

@@ -1,2 +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') {