Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitbucket/markedj

JVM port of graceful markdown processor marked.js
https://github.com/gitbucket/markedj

java markdown

Last synced: 6 days ago
JSON representation

JVM port of graceful markdown processor marked.js

Host: GitHub
URL: https://github.com/gitbucket/markedj
Owner: gitbucket
License: apache-2.0
Created: 2015-09-16T22:49:23.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2025-01-06T08:41:13.000Z (19 days ago)
Last Synced: 2025-01-12T12:13:51.564Z (13 days ago)
Topics: java, markdown
Language: Java
Homepage:
Size: 178 KB
Stars: 86
Watchers: 16
Forks: 23
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # markedj [![build](https://github.com/gitbucket/markedj/workflows/build/badge.svg?branch=master)](https://github.com/gitbucket/markedj/actions?query=branch%3Amaster+workflow%3Abuild) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.gitbucket/markedj/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.gitbucket/markedj) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/markedj/blob/master/LICENSE)

JVM port of graceful markdown processor [marked.js](https://github.com/chjj/marked).

## Usage

First, add following dependency into your `pom.xml`:

```xml

  

    io.github.gitbucket

    markedj

    1.0.20

  

```

You can easily use markedj via `io.github.gitbucket.markedj.Marked`:

```java

import io.github.gitbucket.markedj.*;

String markdown = ...

// With default options

String html1 = Marked.marked(markdown);

// Specify options

Options options = new Options();

options.setSanitize(true);

String html2 = Marked.marked(markdown, options);

```

## Options

`io.github.gitbucket.markedj.Options` has following properties to control Markdown conversion:

Name         | Default | Description

:------------|:--------|:------------

gfm          | true    | Enable [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown).

tables       | true    | Enable GFM [tables](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#wiki-tables). This option requires the `gfm` option to be true.

breaks       | false   | Enable GFM [line breaks](https://help.github.com/articles/github-flavored-markdown#newlines). This option requires the `gfm` option to be true.

sanitize     | false   | Ignore any HTML that has been input.

langPrefix   | "lang-" | Prefix of class attribute of code block

headerPrefix | ""      | Prefix of id attribute of header

safelist     | See [Options.java](https://github.com/gitbucket/markedj/blob/master/src/main/java/io/github/gitbucket/markedj/Options.java) | Safelist of HTML tags.

extensions   | empty   | Extensions. See [Extensions](#extensions) section

By default, markedj uses Jsoup's safelist mechanism for HTML rendering. It restricts renderable tags, attributes and even protocols of attribute values. For example, the image url must be `http://` or `https://` by default. You can remove this restriction by customizing the safelist as follows:

```java

String html1 = Marked.marked("![alt text](/img/some-image.png \"title\")");

  // => 


Options options = new Options();

options.getSafelist().removeProtocols("img", "src", "http", "https");

String html2 = Marked.marked("![alt text](/img/some-image.png \"title\")", options);

  // => 


```

## Extensions

Markedj can be extended by implementing [custom extensions](https://github.com/gitbucket/markedj/blob/master/src/main/java/io/github/gitbucket/markedj/extension/Extension.java).

Extensions can be used by adding them to the options.

```java

Options options = new Options();

options.addExtension(new GFMAlertExtension());

String html = Marked.marked("> [!NOTE]\n> This is a note!", options);

```

### GFMAlert extension

Support for github like [alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts).

For styling, some project-specific CSS is required.

```java

Options options = new Options();

// Override default title for note alert

GFMAlertOptions alertOptions = new GFMAlertOptions();

alertOptions.setTitle(GFMAlerts.Alert.WARNING, "Attention!!!");

GFMAlertExtension gfmAlerts = new GFMAlertExtension(alertOptions);

options.addExtension(gfmAlerts);

String html = Marked.marked("> [!NOTE]\n> This is a note!", options);

```

Supported alert types are `NOTE`, `TOP`, `IMPORTANT`, `WARNING`, and `CAUTION`. Here is a Markdown example:

```markdown

> [!NOTE]

> Useful information that users should know, even when skimming content.

```

This is translated to the following HTML:

```html



  Note

  Useful information that users should know, even when skimming content.



```

Generated HTML can be customized by implementing your own renderer. [DefaultGFMAlertRenderer](https://github.com/gitbucket/markedj/blob/master/src/main/java/io/github/gitbucket/markedj/extension/gfm/alert/DefaultGFMAlertRenderer.java) is used by default.

## for Developers

### Release

Run the following command to upload artifacts to sonatype:

```

mvn clean deploy -DperformRelease=true

```

Then, go to https://oss.sonatype.org/, close and release the staging repository.