chore: release v0.0.0-20230302.1

.browserslistrc

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

.github/workflows/ci.yml

@@ -23,10 +23,10 @@ jobs:
         with:
           node-version: 16
           registry-url: https://registry.npmjs.org/
-      # Step IV
+      # Step III
       - name: Install Dependencies
         run: npm ci
-      # Step V
+      # Step IV
       - name: Lint
         run: npm run lint
   # Test 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

.github/workflows/release.yml

@@ -29,11 +29,16 @@ 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: JS-DevTools/npm-publish@v1
+        uses: rxfork/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}
-      # Step VI
+      # Step VII
       - name: Generate Changelog
         run: npx changelogithub@0.12
         env:

.gitignore

@@ -1 +1,2 @@
 node_modules/
+dist/

.stylelintignore

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

.stylelintrc

@@ -1,4 +1,5 @@
 {
+  "ignoreDisables": true,
   "extends": "stylelint-config-standard-scss",
   "plugins": [
     "stylelint-scss",

.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.

Gruntfile.coffee

@@ -1,7 +1,9 @@
 module.exports = (grunt) ->
-  require('load-grunt-tasks')(grunt)
+  # Load Grunt Tasks
+  require('load-grunt-tasks') grunt
 
-  grunt.initConfig(
+  # Project Configuration
+  grunt.initConfig
     # NPM Package Declare
     pkg: grunt.file.readJSON('package.json')
     # Sass Compile
@@ -26,19 +28,23 @@ module.exports = (grunt) ->
           annotation: 'dist/'
       exp:
         options:
-          processors: [require('autoprefixer')()]
+          processors: [
+            require('postcss-preset-env')()
+            require('autoprefixer')()
+          ]
         src: 'dist/bundle.css'
         dest: 'dist/bundle.css'
       min:
         options:
           processors: [
+            require('postcss-preset-env')()
             require('autoprefixer')()
-            require('cssnano')(
-              preset: 'default'
-            )
+            require('cssnano')(preset: 'default')
           ]
         src: 'dist/bundle.min.css'
         dest: 'dist/bundle.min.css'
-  )
-
-  grunt.registerTask('build', ['sass', 'postcss'])
+  # Register Grunt Tasks
+  grunt.registerTask 'build', [
+    'sass'
+    'postcss'
+  ]

README.md

@@ -0,0 +1,55 @@
+<h1 align="center">x-markdown-css</h1>
+
+<p align="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>
+
+> A simple and customizable Markdown CSS for everyone.
+
+## Requirement
+
+- Node.js >=16
+
+## Install
+
+```sh
+npm install
+```
+
+## Build
+
+```sh
+npm run 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.
+- [Grunt](https://gruntjs.com): Automating build tasks.
+- [PostCSS](https://postcss.org): Transforming CSS dist.
+- [Stylelint](https://stylelint.io): Linting SCSS codes.
+
+*...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.json

@@ -1,6 +1,6 @@
 {
   "name": "x-markdown-css",
-  "version": "0.0.0-20230229.1",
+  "version": "0.0.0-20230302.1",
   "description": "A simple and customizable Markdown CSS for everyone.",
   "keywords": [
     "markdown",
@@ -49,6 +49,7 @@
     "grunt-sass": "^3.1.0",
     "load-grunt-tasks": "^5.1.0",
     "postcss": "^8.4.21",
+    "postcss-preset-env": "^8.0.1",
     "stylelint": "^15.2.0",
     "stylelint-config-standard-scss": "^7.0.1",
     "stylelint-order": "^6.0.2",

src/scss/_partial/_all.scss

@@ -0,0 +1 @@
+@import 'title', 'text', 'link', 'code', 'quote', 'figure', 'list', 'table', 'media';

src/scss/_partial/code.scss

@@ -1,19 +1,21 @@
 code {
-  font-size: .875rem;
+  font-size: .85rem;
   font-weight: 600;
+  font-family: var(--xm-font-mono);
   color: var(--xm-c-dark);
-  &::before, &::after {
+  &::before,
+  &::after {
     content: '`';
   }
 }
 pre {
   overflow-x: auto;
-  margin-top: 1.7143rem;
-  padding-top: .8571rem, 1.1429rem;
-  font-size: .875rem;
+  margin-top: 1.75rem;
+  padding-top: .85rem, 1.15rem;
+  font-size: .85rem;
   color: var(--xm-c-pre);
-  line-height: 1.7143;
-  margin-bottom: 1.7143rem;
+  line-height: 1.75;
+  margin-bottom: 1.75rem;
   border-radius: .375rem;
   code {
     padding: 0;
@@ -25,9 +27,7 @@ pre {
     border-width: 0;
     border-radius: 0;
     line-height: inherit;
-    &::before {
-      content: none;
-    }
+    &::before,
     &::after {
       content: none;
     }

src/scss/_partial/container.scss

@@ -1,12 +1,6 @@
-%container {
+@mixin container {
   max-width: fit-content;
   font-size: 1rem;
   color: var(--xm-c-general);
   line-height: 1.75;
-  > :first-child {
-    margin-top: 0;
-  }
-  > :last-child {
-    margin-bottom: 0;
-  }
 }

src/scss/_partial/figure.scss

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

src/scss/_partial/list.scss

@@ -28,7 +28,7 @@ ul {
     &::before {
       content: '';
       position: absolute;
-      top: calc(.875rem - .1875rem);
+      top: .685rem;
       left: .25rem;
       width: .375rem;
       height: .375rem;

src/scss/_partial/quote.scss

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

src/scss/_partial/table.scss

@@ -3,9 +3,9 @@ table {
   margin-bottom: 2rem;
   width: 100%;
   table-layout: auto;
-  font-size: .875rem;
+  font-size: .85rem;
   text-align: left;
-  line-height: 1.7143;
+  line-height: 1.75;
 }
 thead {
   font-weight: 600;
@@ -14,9 +14,9 @@ thead {
   border-bottom-color: var(--xm-c-thead-border);
   th {
     vertical-align: bottom;
-    padding-right: .5714rem;
-    padding-bottom: .5714rem;
-    padding-left: .5714rem;
+    padding-right: .575rem;
+    padding-bottom: .575rem;
+    padding-left: .575rem;
     &:first-child {
       padding-left: 0;
     }
@@ -35,7 +35,7 @@ tbody {
   }
   td {
     vertical-align: top;
-    padding: .5714rem;
+    padding: .575rem;
     &:first-child {
       padding-left: 0;
     }

src/scss/_partial/title.scss

@@ -4,7 +4,7 @@ h1 {
   font-size: 2.25rem;
   font-weight: 800;
   color: var(--xm-c-darker);
-  line-height: 1.1111;
+  line-height: 1.15;
 }
 h2 {
   margin-top: 2rem;
@@ -12,9 +12,9 @@ h2 {
   font-weight: 700;
   color: var(--xm-c-dark);
   margin-bottom: 1rem;
-  line-height: 1.3334;
+  line-height: 1.35;
   code {
-    font-size: .875rem;
+    font-size: .85rem;
   }
   + * {
     margin-top: 0;

src/scss/_vars/colors.scss

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

src/scss/prose.scss

@@ -1,15 +1,6 @@
 @use '_partial/container' as *;
 
-.markdown-body,
 .prose {
-  @extend %container;
-  @import '_partial/title';
-  @import '_partial/text';
-  @import '_partial/link';
-  @import '_partial/code';
-  @import '_partial/quote';
-  @import '_partial/figure';
-  @import '_partial/list';
-  @import '_partial/table';
-  @import '_partial/media';
+  @include container;
+  @import '_partial/all';
 }