RichMD とは?

RichMD は Markdown をベースに独自の機能を搭載した新しい Markdown です。

RichMD は
「Markdown の良さを残しつつ、機能として Markdown を超えていく」
ことをコンセプトに作っています。
Markdown のような簡単な記法で色々な機能ができる Markdown を目指してます。
JavaScript で作られているので、React や Vue にも対応可能です。
(React や Vue で実装する際は、Webpack のビルド環境が必要です)

npm からインストールできます。
https://www.npmjs.com/package/richmd

RichMD CLI & RichMD file

RichMD は RichMD CLI を搭載しており、これにより RichMD file を作り出すことができました。
RichMD file は拡張子を .richmd にして作成します。

$ touch hello.richmd

詳しい使い方はこちら

RichMD file を使って CSS ファイルを読み込む

v1.0.1 から CSS file のインポートができるようになりました。
これにより、<link> タグを使わなくてもスタイルシートを適用することができます。
以下の記法で記述できます。

::style::./src/style.css

Dropdown Details を簡単に記述できる

Markdown でドロップダウン形式の details を書く時は HTML を直接書いていました。

<details><summary>Summary</summary>
Hello, World!!
</details>

RichMD では以下のように簡単に記述できます。

:>Summary
Hello, World!!
:>

最後に

RichMD はまだまだ発展途上なので、今後も機能を増やして進化していきます。
是非、使ってみてください!

GitHub