Makedownファイルをコンソールで成形表示する方法

Markdownは軽量マークアップ言語で、プレーンテキスト形式での書き込みをHTMLに変換してウェブページで表示するなどの用途で使用します。

見出し、リスト、コードなどの要素を簡単な構文で記述でき、読みやすく書きやすいことが特徴です。

オープンソースのドキュメントなどにも使われています。

通常のテキストエディタでも読むことができますが、指示記号に違和感を覚えます。

コンソールでも成形表示したいと思うでしょう。

「mdless」をインストールしてREADME.mdファイルを成形表示する方法を解説します。

mdlessインストール手順

mdless はRuby gemとして提供されているため、Rubyのgemシステムを使用してインストールできます。

gemを使うにはRubyの開発ヘッダーファイル、C/C++のコンパイラなどのビルドツールが必要になります。

apt -y install ruby ruby-dev build-essential

Rubyをインストールすると、通常RubyGemsもインストールされます。これを確認するには、以下のコマンドを実行します。

gem -v

gem install mdless

この方法で mdless をインストールすることができ、Markdownファイルを整形してコンソール上で読むことが可能になります。ただし、Rubyの環境によっては追加の設定が必要な場合があります。また、システムによっては依存関係があるため、必要に応じてそれらをインストールする必要があります。

mdless README.md

とりあえず表示できます。

Puki wikiなどもMakedownを使っているのかと思いましたが、違うようです。

Makefileを使えばHTMLに詳しくないユーザーでも簡単にドキュメントの装飾ができるのでCMSなどの入力で威力を発揮します。

応用できる素材だと感じました。