JarCasting
JarCasting JarCasting

snarkdown

WebJar for snarkdown

License

License

MIT
Categories

Categories

Github Development Tools Version Controls
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

github-com-developit-snarkdown
Last Version

Last Version

1.2.2
Release Date

Release Date
Type

Type

jar
Description

Description

snarkdown
WebJar for snarkdown
Project URL

Project URL

http://webjars.org
Source Code Management

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
Browse

How to add to project

<!-- 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>
// https://jarcasting.com/artifacts/org.webjars.npm/github-com-developit-snarkdown/
implementation 'org.webjars.npm:github-com-developit-snarkdown:1.2.2'
// https://jarcasting.com/artifacts/org.webjars.npm/github-com-developit-snarkdown/
implementation ("org.webjars.npm:github-com-developit-snarkdown:1.2.2")
'org.webjars.npm:github-com-developit-snarkdown:jar:1.2.2'
<dependency org="org.webjars.npm" name="github-com-developit-snarkdown" rev="1.2.2">
  <artifact name="github-com-developit-snarkdown" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='github-com-developit-snarkdown', version='1.2.2')
)
libraryDependencies += "org.webjars.npm" % "github-com-developit-snarkdown" % "1.2.2"
[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 npm

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

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

Versions

Version
1.2.2