Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sukkaw/markdown.css

:memo: The simple CSS to replicate the GitHub Markdown style (Sukka Ver.)
https://github.com/sukkaw/markdown.css

browser css markdown md style stylesheet

Last synced: 1 day ago
JSON representation

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

Host: GitHub
URL: https://github.com/sukkaw/markdown.css
Owner: SukkaW
License: mit
Created: 2018-11-07T13:32:18.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-12-03T00:44:39.000Z (almost 2 years ago)
Last Synced: 2024-04-24T23:20:12.197Z (5 months ago)
Topics: browser, css, markdown, md, style, stylesheet
Language: CSS
Homepage:
Size: 550 KB
Stars: 15
Watchers: 3
Forks: 1
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # @sukka/markdown.css

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

[![NPM](https://img.shields.io/npm/v/@sukka/markdown.css.svg?style=flat-square)](https://www.npmjs.com/package/@sukka/markdown.css)

[![Author](https://img.shields.io/badge/Author-Sukka-b68469.svg?style=flat-square)](https://skk.moe)

[![Travis](https://img.shields.io/travis/SukkaW/markdown.css.svg?style=flat-square)](https://travis-ci.org/SukkaW/markdown.css)

[![devDependency Status](https://img.shields.io/david/dev/SukkaW/markdown.css.svg?style=flat-square)](https://david-dm.org/SukkaW/markdown.css?type=dev)

[![LICENSE](https://img.shields.io/github/license/sukkaw/markdown.css.svg?style=flat-square)](./LICENSE)

[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/@sukka/markdown.css/badge)](https://www.jsdelivr.com/package/npm/@sukka/markdown.css)

## Why

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

| compression | github-markdown-css | @sukka/markdown.css |

|:---:|:---:|:---:|

| none | ![](https://img.badgesize.io/sindresorhus/github-markdown-css/gh-pages/github-markdown.css?style=flat-square&label=original%20size) | ![](https://img.badgesize.io/SukkaW/markdown.css/master/dist/markdown.min.css?style=flat-square&label=original%20size) |

| gzip | ![](https://img.badgesize.io/sindresorhus/github-markdown-css/gh-pages/github-markdown.css?compression=gzip&style=flat-square) | ![](https://img.badgesize.io/SukkaW/markdown.css/master/dist/markdown.min.css?compression=gzip&style=flat-square) |

| brotli | ![](https://img.badgesize.io/sindresorhus/github-markdown-css/gh-pages/github-markdown.css?compression=brotli&style=flat-square) | ![](https://img.badgesize.io/SukkaW/markdown.css/master/dist/markdown.min.css?compression=brotli&style=flat-square) | ![](https://img.badgesize.io/SukkaW/markdown.css/master/dist/markdown.min.css?compression=brotli&style=flat-square) |

## Demo

https://suka.js.org/markdown.css

## Install

### NPM or Yarn

```bash

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

```html

```

## Usage

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

```html

    
Sukka

    Fairytale is only beautiful but never continued


```

## Author

**@sukka/markdown.css** © [Sukka](https://github.com/SukkaW), Released under the [MIT](./LICENSE) License.


Authored and maintained by Sukka with help from contributors ([list](https://github.com/SukkaW/markdown.css/contributors)).

> [Personal Website](https://skk.moe) · [Blog](https://blog.skk.moe) · GitHub [@SukkaW](https://github.com/SukkaW) · Telegram Channel [@SukkaChannel](https://t.me/SukkaChannel) · Twitter [@isukkaw](https://twitter.com/isukkaw) · Keybase [@sukka](https://keybase.io/sukka)