JarCasting
JarCasting JarCasting

render-readme

WebJar for render-readme

Лицензия

Лицензия

MIT
Группа

Группа

org.webjars.npm
Идентификатор

Идентификатор

render-readme
Последняя версия

Последняя версия

0.2.1
Дата

Дата
Тип

Тип

jar
Описание

Описание

render-readme
WebJar for render-readme
Ссылка на сайт

Ссылка на сайт

http://webjars.org
Система контроля версий

Система контроля версий

https://github.com/rlidwka/render-readme

Скачать render-readme

Имя Файла Размер
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
Обзор

Как подключить последнюю версию

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

Зависимости

compile (4)

Идентификатор библиотеки Тип Версия
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)

Модули Проекта

Данный проект не имеет модулей.

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)

Версии библиотеки

Версия
0.2.1