1 | <div align="center">
|
2 | <div>
|
3 | <img width="300" src="https://github.com/yahtnif/static/raw/master/logo/smarkdown.svg?sanitize=true" alt="smarkdown">
|
4 | </div>
|
5 | </div>
|
6 |
|
7 | [![npm](https://badgen.net/npm/v/smarkdown)](https://www.npmjs.com/package/smarkdown)
|
8 | [![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/smarkdown/dist/smarkdown.min.js?compression=gzip)](https://cdn.jsdelivr.net/npm/smarkdown/dist/smarkdown.min.js)
|
9 | [![install size](https://badgen.net/packagephobia/install/smarkdown)](https://packagephobia.now.sh/result?p=smarkdown)
|
10 | [![downloads](https://badgen.net/npm/dt/smarkdown)](https://www.npmjs.com/package/smarkdown)
|
11 | [![Build Status](https://travis-ci.org/yahtnif/smarkdown.svg?branch=master)](https://travis-ci.org/yahtnif/smarkdown)
|
12 | [![LICENSE](https://img.shields.io/badge/license-Anti%20996-blue.svg)](https://github.com/996icu/996.ICU/blob/master/LICENSE)
|
13 |
|
14 | > Markdown parser, simplicity and extensibility. Fork of [marked](https://github.com/markedjs/marked) and [marked-ts](https://github.com/KostyaTretyak/marked-ts).
|
15 |
|
16 | ## Features
|
17 |
|
18 | - **Awesome:** ES6, TypeScript, Rollup, Jest...
|
19 | - **Extensible:** Add your own [extensions](#extensions)
|
20 | - **Fast:** Low-level compiler for parsing markdown without caching or blocking for long periods of time
|
21 | - **Lightweight:** It's 9kb of minified and gzipped
|
22 |
|
23 | ## Install
|
24 |
|
25 | ```sh
|
26 | yarn add smarkdown
|
27 | # or
|
28 | npm install smarkdown
|
29 | ```
|
30 |
|
31 | **browser (CDN):** [jsDelivr](https://www.jsdelivr.com/package/npm/smarkdown) | [unpkg](https://unpkg.com/smarkdown/)
|
32 |
|
33 | ## Usage
|
34 |
|
35 | Import the library as a module:
|
36 |
|
37 | ```js
|
38 | const Smarkdown = require('smarkdown')
|
39 | ```
|
40 |
|
41 | Or import the library with a script tag:
|
42 |
|
43 | ```html
|
44 | <script src="https://cdn.jsdelivr.net/npm/smarkdown/dist/smarkdown.min.js"></script>
|
45 | ```
|
46 |
|
47 | Example:
|
48 |
|
49 | ```js
|
50 | const str = 'I am using **Smarkdown**.'
|
51 |
|
52 | console.log(Smarkdown.parse(str))
|
53 | // <p>I am using <strong>Smarkdown</strong>.</p>
|
54 |
|
55 | console.log(Smarkdown.parse(str, { nop: true }))
|
56 | // I am using <strong>Smarkdown</strong>.
|
57 | ```
|
58 |
|
59 | ## More
|
60 |
|
61 | - [Syntax highlighting](docs/syntax-highlighting.md)
|
62 | - [Options](docs/options.md)
|
63 | - [Extension](docs/extension.md)
|
64 | - [Renderer](docs/renderer.md)
|
65 |
|
66 | ## Comparison
|
67 |
|
68 | | | Smarkdown | Marked | markdown-it |
|
69 | | :----------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
70 | | Version | [![npm](https://badgen.net/npm/v/smarkdown)](https://www.npmjs.com/package/smarkdown) | [![npm](https://badgen.net/npm/v/marked)](https://www.npmjs.com/package/marked) | [![npm](https://badgen.net/npm/v/markdown-it)](https://www.npmjs.com/package/markdown-it) |
|
71 | | Minified & Gzipped | [![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/smarkdown/dist/smarkdown.min.js?compression=gzip)](https://cdn.jsdelivr.net/npm/smarkdown/dist/smarkdown.min.js) | [![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/marked/marked.min.js?compression=gzip)](https://cdn.jsdelivr.net/npm/marked/marked.min.js) | [![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js?compression=gzip)](https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js) |
|
72 |
|
73 | ## License
|
74 |
|
75 | [Anti 996](./LICENSE)
|