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
148 Commits 4 Branches 62 Tags 496 KiB
SCSS 82.9%
CoffeeScript 17.1%
Go to file
郭桓桓 cfa79e400a
chore: release v0.0.2 		2023-03-04 18:55:23 +08:00
.github chore(ci): include all files in `dist` instead of the dir to `build.tar.gz` 2023-03-03 20:58:09 +08:00
.vscode docs: add `README.md` and `CONTRIBUTING.md` 2023-03-01 23:07:31 +08:00
src refactor(fonts)!: add `font-code` to let managing code fonts more flexible 2023-03-04 17:19:15 +08:00
.browserslistrc chore(browserslist): only browsers support `css-variables` 2023-03-02 19:29:37 +08:00
.editorconfig chore(config): add top comment to `.editorconfig` 2023-03-04 17:22:46 +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(build): remove useless blank line in `Gruntfile.coffee` 2023-03-04 17:25:33 +08:00
LICENSE chore(license): add MIT License 2023-02-28 19:55:11 +08:00
README.md docs(readme): add usage in CSS files 2023-03-04 18:44:50 +08:00
package-lock.json chore: release v0.0.2 2023-03-04 18:55:23 +08:00
package.json chore: release v0.0.2 2023-03-04 18:55:23 +08:00

README.md

x-markdown-css

NPM Version GitHub Actions MIT License

A simple and customizable markdown CSS stylesheet for everyone.

Browsers Support

According to .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!

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

  1. A CSS (with Node.js) / Sass / SCSS project:

First, install it with NPM (PNPM or Yarn also works):

npm i x-markdown-css@latest

Then, add it to your .css / .sass / .scss file.

For example, in CSS / SCSS you do:

@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:

...and much more.

Development

Requirement

  • Node.js >= 16

Install

npm i

Build

npm run build

or

grunt build

or

npx grunt build

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.