render-readme

WebJar for render-readme

License	MIT
GroupId	org.webjars.npm
ArtifactId	render-readme
Last Version	0.2.1
Release Date	Nov 19, 2016
Type	jar
Description	render-readme WebJar for render-readme
Project URL	http://webjars.org
Source Code Management	https://github.com/rlidwka/render-readme

Download render-readme

Filename	Size
render-readme-0.2.1.pom
render-readme-0.2.1.jar	13 KB
render-readme-0.2.1-sources.jar	22 bytes
render-readme-0.2.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/render-readme/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>render-readme</artifactId>
    <version>0.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/render-readme/
implementation 'org.webjars.npm:render-readme:0.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/render-readme/
implementation ("org.webjars.npm:render-readme:0.2.1")

Apache Buildr

'org.webjars.npm:render-readme:jar:0.2.1'

Apache Ivy

<dependency org="org.webjars.npm" name="render-readme" rev="0.2.1">
  <artifact name="render-readme" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='render-readme', version='0.2.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "render-readme" % "0.2.1"

Leiningen

[org.webjars.npm/render-readme "0.2.1"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.webjars.npm : remarkable	jar	1 >=1.4
org.webjars.npm : sanitize-html	jar	1 >=1.4
org.webjars.npm : js-yaml	jar	3 >=3.2
org.webjars.npm : highlight.js	jar	[8,9)

Project Modules

There are no modules declared in this project.

Render and sanitize readme.md just like github would.

Basically, it's node.js version for this: https://github.com/github/markup

But only for markdown for now, because that's what io.js packages use mostly.

API

require('render-readme')('Hello, *world*!')

// outputs '<p>Hello, <em>world</em>!</p>\n'

Features

• the basic rendering is commonmark + gfm extensions (emphasis slightly differs, but nobody cares anyway)
• html is sanitized, the configuration is similar to github stuff (using sanitize-html)
• syntax highlighting (using highlight-js for this one)
• YAML metadata on top of markdown documents is rendered to a table
• anchors for headers (<a name="blah"> instead of <a id="user-content-blah">, but should be good enough)

Versions

Version
0.2.1 Nov 19, 2016