@sukka/markdown.css

The simple CSS to replicate the GitHub Markdown style (Sukka Ver.)

Why

You might ask why I want to create the project, There are already many similar projects, for example github-markdown-css. Well, let's look at some comparisons:

compression	github-markdown-css	@sukka/markdown.css
none
gzip
brotli

Demo

Work in Progress.

Install

NPM or Yarn

# NPM
$ npm i @sukka/markdown.css --save
# Yarn
$ yarn add @sukka/markdown.css

CDN

Alternatively, you can use the unpkg or jsdelivr CDN to load compiled markdown.css.

<!-- jsDelivr -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@sukka/markdown.css">

Usage

Import the markdown.css file and add a markdown-body class to the container of your rendered Markdown.

<article class="markdown-body">
    <h1>Sukka</h1>
    <p>Fairytale is only beautiful but never continued</p>
</article>

Author

@sukka/markdown.css © Sukka, Released under the MIT License.
Authored and maintained by Sukka with help from contributors (list).

Personal Website · Blog · GitHub @SukkaW · Telegram Channel @SukkaChannel · Twitter @isukkaw · Keybase @sukka