docs(readme): add usage in CSS files

.editorconfig

@@ -1,3 +1,5 @@
+# EditorConfig <http://editorconfig.org>
+
 root = true
 
 [*]

.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
@@ -62,4 +62,4 @@ jobs:
           path: dist/
           retention-days: 3
 
-# Authored by KuoHuanHuan.
+# Authored by @kuohuanhuan.

.github/workflows/release.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   # NPM Registry & GitHub Release
   release:
-    # Use Ubuntu 22.04
+    # Use Ubuntu 22.04 LTS
     runs-on: ubuntu-22.04
     steps:
       # Step I
@@ -29,11 +29,12 @@ jobs:
       - name: Build Project
         run: npm run build
       # Step V
-      - name: Create Zip File
-        uses: vimtor/action-zip@v1.1
+      - name: Create tar.gz File
+        uses: TheDoctor0/zip-release@0.7.1
         with:
-          files: dist/
-          dest: build.zip
+          type: tar
+          path: dist/*
+          filename: build.tar.gz
       # Step VI
       - name: Publish to NPM Registry
         uses: rxfork/npm-publish@v1
@@ -45,11 +46,23 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       # Step VIII
-      - name: GitHub Release
+      # / 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.zip
+            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.
+# Authored by @kuohuanhuan.

.npmignore

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

Gruntfile.coffee

@@ -1,7 +1,6 @@
 module.exports = (grunt) ->
   # Load Grunt Tasks
   require('load-grunt-tasks') grunt
-
   # Project Configuration
   grunt.initConfig
     # NPM Package Declare
@@ -29,7 +28,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 +39,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 +53,5 @@ module.exports = (grunt) ->
     'sass'
     'postcss'
   ]
+
+# Authored by @kuohuanhuan.

README.md

@@ -2,25 +2,75 @@
 
 <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)
+[![NPM Version](https://img.shields.io/npm/v/x-markdown-css)](https://www.npmjs.com/package/x-markdown-css)
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/kuohuanhuan/x-markdown-css/ci.yml)](https://github.com/kuohuanhuan/x-markdown-css/actions/workflows/ci.yml)
+[![MIT License](https://img.shields.io/github/license/kuohuanhuan/x-markdown-css?color=blue)](https://github.com/kuohuanhuan/x-markdown-css/blob/master/LICENSE)
 
 </center>
 
 > 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. Note that `bundle.css` without `.min` stands for unminified version.*
+
+2. A CSS (with Node.js) / 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 `.css` / `.sass` / `.scss` file.
+
+For example, in CSS / SCSS you do:
+
+```css
+@import 'x-markdown-css';
+```
+
+> *ps. Note that no path or file extention is required
+> since the `style` and `sass` field in `package.json` is filled.  
+> Just simply use `'x-markdown-css'` to import it.*
+
+## Built with
+
+The following tools and suite libraries made the development of `x-markdown-css` possible:
+
+- [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 +88,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)
-- [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!  

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230302.12",
+  "version": "0.0.1-patch.3",
   "description": "A simple and customizable markdown CSS stylesheet for everyone.",
   "keywords": [
     "markdown",
@@ -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,5 +1,5 @@
 .markdown-body {
-  color: var(--xm-c-general);
+  color: var(--xm-c-regular);
   font-family: var(--xm-font-display) !important;
   pre:not(.shiki, .highlight) {
     margin: 0;
@@ -10,7 +10,7 @@
   .highlight {
     margin: .5rem 0;
     font-size: 1.05rem;
-    font-family: var(--xm-font-mono) !important;
+    font-family: var(--xm-font-code) !important;
     line-height: 1.4;
     &.shiki-light {
       background: var(--xm-c-shiki-light) !important;
@@ -28,7 +28,7 @@
     text-decoration: none;
     transition: border .3s ease-in-out;
     &:hover {
-      border-bottom: 1px solid var(--xm-c-general);
+      border-bottom: 1px solid var(--xm-c-regular);
     }
     code {
       color: inherit;
@@ -36,7 +36,8 @@
   }
   hr {
     width: 50px;
-    margin: 2rem auto;
+    margin-top: 2rem;
+    margin-bottom: 2rem;
   }
   blockquote,
   q {
@@ -95,7 +96,7 @@ html:not(.dark) .shiki-dark,
     &:hover,
     &:focus {
       .header-anchor {
-        opacity: .5;
+        opacity: .35 + $i * .025;
       }
     }
   }

src/scss/partials/_container.scss

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

src/scss/partials/code.scss

@@ -1,8 +1,8 @@
 code {
-  color: var(--xm-c-dark);
+  color: var(--xm-c-deep);
   font-weight: 600;
   font-size: .875rem;
-  font-family: var(--xm-font-mono);
+  font-family: var(--xm-font-code);
   &::before,
   &::after {
     content: '`';

src/scss/partials/link.scss

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

src/scss/partials/text.scss

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

src/scss/partials/title.scss

@@ -1,7 +1,7 @@
 h1 {
   margin-top: 0;
   margin-bottom: .875rem;
-  color: var(--xm-c-darker);
+  color: var(--xm-c-deeper);
   font-weight: 800;
   font-size: 2.25rem;
   line-height: 1.15;
@@ -9,7 +9,7 @@ h1 {
 h2 {
   margin-top: 2rem;
   margin-bottom: 1rem;
-  color: var(--xm-c-dark);
+  color: var(--xm-c-deep);
   font-weight: 700;
   font-size: 1.5rem;
   line-height: 1.35;

src/scss/variables/_colors.scss

@@ -1,13 +1,18 @@
-$shiki-light: #f8f8f8;
-$shiki-dark: #0e0e0e;
-$link-border: hsla(0deg 0 50% / .3);
+// Colors
+$pre: #e5e7eb;
 $code: #111827;
+$figcaption: #6b7280;
+$thead: #111827;
 $ol-counter: #6b7280;
 $ul-counter: #d1d5db;
-$hr-border: hsla(0deg 0 50% / .3);
-$quote-border: hsla(0deg 0 50% / .3);
-$figcaption: #6b7280;
-$pre: #e5e7eb;
-$thead: #111827;
+
+// Border
+$link-border: hsla(0deg 0% 50% / .3);
+$hr-border: hsla(0deg 0% 50% / .3);
+$quote-border: hsla(0deg 0% 50% / .3);
 $thead-border: #d1d5db;
 $tr-border: #e5e7eb;
+
+// Shiki (code highlight)
+$shiki-light: #f8f8f8;
+$shiki-dark: #0e0e0e;

src/scss/variables/_constants.scss

@@ -1,5 +1,8 @@
+// Font stack
 $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 defaults
 $font-display: var(--xm-font-sans);
+$font-code: var(--xm-font-mono);

src/scss/variables/_dark.scss

@@ -1,3 +0,0 @@
-$general: #bbb;
-$dark: #ddd;
-$darker: #fff;

src/scss/variables/_light.scss

@@ -1,3 +0,0 @@
-$general: #555;
-$dark: #222;
-$darker: #000;

src/scss/variables/modes/_dark.scss

@@ -0,0 +1,3 @@
+$regular: #bbb;
+$deep: #ddd;
+$deeper: #fff;

src/scss/variables/modes/_light.scss

@@ -0,0 +1,3 @@
+$regular: #555;
+$deep: #222;
+$deeper: #000;

src/scss/vars.scss

@@ -2,8 +2,9 @@
 
 @use 'variables/constants';
 @use 'variables/colors';
-@use 'variables/light';
-@use 'variables/dark';
+
+@use 'variables/modes/light';
+@use 'variables/modes/dark';
 
 :root {
   @each $name, $val in module-variables('constants') {