kuohuanhuan
/
x-markdown-css
mirror of https://github.com/kuohuanhuan/x-markdown-css.git
1
0
Fork 0
Code Releases Wiki Activity
A simple and customizable markdown CSS stylesheet for everyone. (mirror of GitHub) https://npmjs.com/package/x-markdown-css
107 Commits 4 Branches 62 Tags 498 KiB
SCSS 82.9%
CoffeeScript 17.1%
Go to file
郭桓桓 65b4b24002
chore(ci): create a `tar.gz` file instead of a `.zip` one 		2023-03-03 19:04:32 +08:00
.github chore(ci): create a `tar.gz` file instead of a `.zip` one 2023-03-03 19:04:32 +08:00
.vscode docs: add `README.md` and `CONTRIBUTING.md` 2023-03-01 23:07:31 +08:00
src style(markdown): improve selectors 2023-03-02 21:18:14 +08:00
.browserslistrc chore(browserslist): only browsers support `css-variables` 2023-03-02 19:29:37 +08:00
.editorconfig init: create project & upload files 2023-02-28 18:35:20 +08:00
.gitignore chore(ci): use different `.gitignore` with GitHub Actions 2023-03-01 20:34:07 +08:00
.npmignore chore(ci): create a `tar.gz` file instead of a `.zip` one 2023-03-03 19:04:32 +08:00
.stylelintignore chore(lint): normalize `.stylelintignore` 2023-03-02 19:19:12 +08:00
.stylelintrc chore(lint): fix incorrect comma placing in `.stylelintrc` 2023-03-02 20:21:26 +08:00
CONTRIBUTING.md docs: add `README.md` and `CONTRIBUTING.md` 2023-03-01 23:07:31 +08:00
Gruntfile.coffee chore: create and modify footer author comment 2023-03-03 18:45:16 +08:00
LICENSE chore(license): add MIT License 2023-02-28 19:55:11 +08:00
README.md docs(readme): remove descriptions of packages in "Uses" 2023-03-02 20:31:42 +08:00
package-lock.json chore: release v0.0.0-20230302.12 2023-03-02 23:15:01 +08:00
package.json chore(npm): replace `main` key in `package.json` with `sass` and `style` 2023-03-03 18:34:08 +08:00

README.md

x-markdown-css

Version Node.js Requirement MIT License

A simple and customizable markdown CSS stylesheet for everyone.

Requirement

  • Node.js >= 16

Install

npm i

Build

npm run build

or

grunt build

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!

ps. bundle.css without .min stands for unminified version.

Uses

...and much more.

Contributing

PRs, issues and feature requests are welcome!
Feel free to check Issues page. You can also take a look at the Contributing Guide.

License

Copyright (c) 2023 kuohuanhuan, licensed under MIT.