ITエンジニア/デザイナ向けにオープンソースを毎日紹介

ドキュメントを書く際にはテキストそのままではなく、何らかのマークアップ言語を使う人が増えています。例えばMarkdownを使っている人はとても多いのですが、機能的に物足りないと感じることも多々あります。

他のマークアップ言語では多機能ながら記法が難しかったりと二の足を踏んでしまっている方も多いでしょう。そこで紹介したいのが国産のマークアップ言語KARASです。

KARASの使い方

KARASの記法はシンプルです。例えば=を行頭に書くとhタグになります。

= Heading level 1
== Heading level 2 :: ID
=== Heading level 3
==== Heading level 4
===== Heading level 5
====== Heading level 6

リスト、定義リストにも対応しています。

; Definition term
;; Definition description 1
;; Definition description 2

<dl>
    <dt>Definition term</dt>
    <dd>Definition description 1</dd>
    <dd>Definition description 2</dd>
</dl>

入力と出力を表すタグも使えます。

$$ < Keyboard text > $$
$$$ > Sample text $$$

<kbd>&lt; Keyboard text &gt;</kbd>
<samp>&gt; Sample text</samp>

ルビも使えたりするのは日本製ならではかも知れません。

'''KANJI::ruby'''
'''KAN::ru::JI::by'''

<ruby>KANJI<rp> (</rp><rt>ruby</rt><rp> )</rp></ruby>
<ruby>KAN<rp> (</rp><rt>ru</rt><rp> )</rp>JI<rp> (</rp><rt>by</rt><rp> )</rp></ruby>

その他上付き、下付き文字やテーブル、小さな引用/大きな引用、動画、音声とかなり高機能な作りになっています。とは言え構文はシンプルで分かりやすいです。

サンドボックスで試しているところです。
サンドボックスで試しているところです。

プラグインによる拡張にも対応していて、周辺環境が整えばさらに利便性が増しそうです。既にライブラリがC#、Javascript、PHP、Rubyと用意されていて、WordPressやJekyll向けにプラグインも提供されています。

Markdownよりも高機能で、reStructuredTextよりも分かりやすい所に重点が置かれているとのことです。Markdownでは独自の拡張がされていますが、KARASでは標準の仕組みとして存在するのはとても良さそうです。今後に期待したいマークアップです。

KARASはBSD Licenseのオープンソース・ソフトウェアです。

KARAS.js

KARAS - What's KARAS ?

KARAS-LightweightMarkupLanguage

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2