Markdown文章をHTMLに変換するJavaライブラリ MarkdownJ を使ってみよう

投稿者 : OSCA

 文章を記述するための軽量マークアップ言語である Markdown。 本稿では、Markdown 文章を HTML に変換する Java ライブラリ MarkdownJ について解説します。

概要

 MarkdownJ は、マークダウン文章を HTML に変換してくれる軽量ライブラリです。 GitHub のプロジェクトページはこちらで、2015年01月現在でバージョン 0.4 が最新です。

MarkdownJ の導入

 プロジェクトに MarkdownJ を導入するには、次のように Maven プロジェクトの依存関係を追記するのが簡単です。

<dependency>
  <groupId>org.markdownj</groupId>
  <artifactId>markdownj-core</artifactId>
 <version>0.4</version>
</dependency>

 Maven を利用していないプロジェクトの場合も、Maven のリポジトリから jar ファイルをダウンロードするのが良いと思います。 もしくは GitHub からソースコードをダウンロードしてコンパイルする方法もあります。

サンプルプログラム

 それではさっそく MarkdownJ を使ってみましょう。 次のようにサンプルプログラムを作成しました。 変換したいマークダウン文章を文字列で宣言し、あとは MarkdownJ を利用して HTML に変換します。

// マークダウン文章を宣言
String mdtext = "This is *sample* text.";

// マークダウン文章をHTMLに変換
MarkdownProcessor processor = new MarkdownProcessor();
String html = processor.markdown(mdtext);
System.out.println(html);

 このプログラムを実行すると次のように画面出力されます。

<p>This is <em>sample</em> text.</p>

 文章は p タグで囲まれ、強調指定した箇所は em タグで更に囲まれました。

 次にもう少し複雑な構造のマークダウン文章を変換してみたいと思います。 プログラムは同様にして変換前文字列を次のようにしたところ、次のような変換結果になりました。

[変換前]

# タイトル

* 目次1
* 目次2

## 節1
ここでは *markdownj* について解説します。

[変換後]

<h1>タイトル</h1>

<ul>
<li>目次1</li>
<li>目次2</li>
</ul>

<h2>節1</h2>

<p>ここでは <em>markdownj</em> について解説します。</p>

 このように MarkdownJ はとても簡単な使い方で HTML への変換機能を提供してくれています。

おわりに

 本稿ではマークダウン文章を HTML に変換してくれる Java ライブラリ MarkdownJ について概要と使い方を解説しました。 皆様のお仕事のお役に立てれば幸いです。

Java環境構築へ戻る

著者 : OSCA

OSCA

 初級WEBエンジニアです。最近は Android, iOS, WEBアプリの作成に力を入れています。 個人として何か一つでも世の中の多くの人に使ってもらえるアプリを作ろうと日々奮闘中です。