first commit
This commit is contained in:
53
node_modules/snarkdown/README.md
generated
vendored
Normal file
53
node_modules/snarkdown/README.md
generated
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
<p align="center">
|
||||
<img src="https://cdn.jsdelivr.net/emojione/assets/svg/1f63c.svg" width="256" height="256" alt="Snarkdown">
|
||||
</p>
|
||||
<h1 align="center">
|
||||
Snarkdown
|
||||
<a href="https://www.npmjs.org/package/snarkdown">
|
||||
<img src="https://img.shields.io/npm/v/snarkdown.svg?style=flat" alt="npm">
|
||||
</a>
|
||||
</h1>
|
||||
|
||||
Snarkdown is a dead simple **1kb** [Markdown] parser.
|
||||
|
||||
It's designed to be as minimal as possible, for constrained use-cases where a full Markdown parser would be inappropriate.
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- **Fast:** since it's basically one regex and a huge if statement
|
||||
- **Tiny:** it's 1kb of gzipped ES3
|
||||
- **Simple:** pass a Markdown string, get back an HTML string
|
||||
|
||||
> **Note:** Tables are not yet supported. If you love impossible to read regular expressions, submit a PR!
|
||||
>
|
||||
> **Note on XSS:** Snarkdown [doesn't sanitize HTML](https://github.com/developit/snarkdown/issues/70), since its primary target usage doesn't require it.
|
||||
|
||||
## Demos & Examples
|
||||
|
||||
- ⚛️ [**Snarky**](https://snarky.surge.sh) - markdown editor built with Preact & Snarkdown
|
||||
- ✏️ [**Simple Markdown Editor**](http://jsfiddle.net/developit/828w6t1x/)
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Snarkdown exports a single function, which parses a string of Markdown and returns a String of HTML. Couldn't be simpler.
|
||||
|
||||
The snarkdown module is available in [every module format](https://unpkg.com/snarkdown/dist/) you'd ever need: ES Modules, CommonJS, UMD...
|
||||
|
||||
```js
|
||||
import snarkdown from 'snarkdown';
|
||||
|
||||
let md = '_this_ is **easy** to `use`.';
|
||||
let html = snarkdown(md);
|
||||
console.log(html);
|
||||
// <em>this</em> is <strong>easy</strong> to <code>use</code>.
|
||||
```
|
||||
|
||||
### Add-ons and Libraries
|
||||
|
||||
- For Webpack users, [`snarkdown-loader`](https://github.com/Plugin-contrib/snarkdown-loader) renders markdown files to html.
|
||||
|
||||
|
||||
|
||||
[Markdown]: http://daringfireball.net/projects/markdown/
|
||||
Reference in New Issue
Block a user