🎉

シンプルでリッチな Markdown を提供する RichMD をリリースしました !

1 min read

RichMD とは?

RichMD は既存の Markdown 記法を拡張したリッチな Markdown です。

今までも Markdown を拡張するライブラリは出ていましたが、大半が追加で拡張機能ライブラリをインストールしてソースコードに組み込むという感じでした。

RichMD は拡張機能を独自の記法で呼び出すことで多くの機能をシンプルに提供できるようになりました。
これまで RichMD と同様に独自記法を導入しているWebアプリはありますが、 OSS ライブラリである RichMD は誰でも高機能な Markdown を使えることができます。

RichMD CLI と 新しいファイル拡張子 .richmd

RichMD は RichMD CLI という独自の CLI を実装しています。
これにより、独自拡張子の .richmd を作成して、HTML に変換する事ができるようになりました。
元々 RichMD を使うには webpack によるビルド環境の構築が必須でしたが、RichMD CLI を実装したことにより、非常に簡単に RichMD を使えるようになりました。
今後はこちらの機能をより充実させるために、アップデートしていく予定です。

詳しい使い方はこちらのドキュメントを参照してください。

インストール

npm or yarn でインストールします。

$ npm install richmd

or

$ yarn add richmd

RichMD が提供する機能

現在 RichMD が提供する機能はこちらです。

  • 基本的な Markdown
  • 数式(ブロック&インラインブロック)
  • カラーブロック

また、今後はこちらも実装していく予定です

  • ビデオ
  • スライドモード
  • カラーテキスト
  • ドロップダウンリスト
  • css 変更

参考: https://github.com/bebeji-nappa/richmd#markdown-syntax

Github

https://github.com/bebeji-nappa/richmd

最後に

まだまだ発展途上なので、今後も使いやすいように機能を実装していきます。
是非、使ってみてください!

Discussion

ログインするとコメントできます