snarkdown

WebJar for snarkdown

License	MIT
Categories	Github Development Tools Version Controls
GroupId	org.webjars.npm
ArtifactId	github-com-developit-snarkdown
Last Version	1.2.2
Release Date	Dec 5, 2018
Type	jar
Description	snarkdown WebJar for snarkdown
Project URL	http://webjars.org
Source Code Management	https://github.com/developit/snarkdown

Download github-com-developit-snarkdown

Filename	Size
github-com-developit-snarkdown-1.2.2.pom
github-com-developit-snarkdown-1.2.2.jar	10 KB
github-com-developit-snarkdown-1.2.2-sources.jar	22 bytes
github-com-developit-snarkdown-1.2.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/github-com-developit-snarkdown/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>github-com-developit-snarkdown</artifactId>
    <version>1.2.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/github-com-developit-snarkdown/
implementation 'org.webjars.npm:github-com-developit-snarkdown:1.2.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/github-com-developit-snarkdown/
implementation ("org.webjars.npm:github-com-developit-snarkdown:1.2.2")

Apache Buildr

'org.webjars.npm:github-com-developit-snarkdown:jar:1.2.2'

Apache Ivy

<dependency org="org.webjars.npm" name="github-com-developit-snarkdown" rev="1.2.2">
  <artifact name="github-com-developit-snarkdown" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='github-com-developit-snarkdown', version='1.2.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "github-com-developit-snarkdown" % "1.2.2"

Leiningen

[org.webjars.npm/github-com-developit-snarkdown "1.2.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Snarkdown

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, since its primary target usage doesn't require it.

Demos & Examples

• ⚛️ Snarky - markdown editor built with Preact & Snarkdown
• ✏️ Simple Markdown Editor

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 you'd ever need: ES Modules, CommonJS, UMD...

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 renders markdown files to html.

Versions

Version
1.2.2 Dec 5, 2018