てがろぐをマークダウンに変換する
概要
- Javascriptで、てがろぐで書いた文章をマークダウンに変換します
- マークダウンに変換する markdown-it - MIT License
- コードをハイライトする highlight.js - BSD 3-Clause License
- 許諾・報告不要です。ご自由にコピペしてご利用ください。
- 非公式のため、使用にあたり自己責任でお願いいたします。
使い方
まず、使用するにあたり、マークダウンに変換したい範囲を指定します。 てがろぐ本文すべてと、一部を変換するかで方法が異なります。
1-1.本文すべてをマークダウンにしたい場合
(一部てがろぐの装飾記法が使えなくなります)
てがろぐ本文([[COMMENT]])
を<div class="comment">[[COMMENT]]</div>
このように囲んでください。
クラス名はお好きな内容で問題ありませんが、この後記述するスクリプト内で適切に書き換えてください。
1-2.本文の一部をマークダウンにしたい場合
自由装飾記法2で指定します。
投稿本文の指定したい部分を、決まった名前(ここでは「md」と指定します)で指定してください。
2. 外側スキンに追記
下記のコードをコピペして、外側スキンの<body>
内に追記します。
ハイライトしているvar inputElements = document.querySelectorAll('.comment');
で、
<div class="comment">
にした人はそのまま、
自由装飾記法「md」で指定した人はvar inputElements = document.querySelectorAll('.deco-md');
と変更します。
マークダウンだけ使いたい人はこれで完成です。
highlight.jsを使う人向け
ブロックコードなどをいい感じにハイライトしてくれるライブラリがあります。 今回はhighlight.jsを合わせて設定します。 外側スキンの先ほどの内容の下に、下記のコードをコピペしてください。
あわせて<head>
タグ内でスタイルシートを読み込んでください。
highlight.jsの公式サイトで、好きなデザインを選べます。 「Theme」で選んだ名前を確認して、「~styles/名前.min.css」部分を書き換えてください。 例ではmonokaiを選んでいます。
備考
マークダウンの記法自体は注意事項に上げたもの以外はmarkdown-itに準じます。 今回使用したサイトのデモページが参考になります。 オプションのカスタマイズもできるので、できそうな方はやってみてください! (GitHubのページ)
マークダウンでのテーブルジェネレーターもあります。 Markdown表テーブル作成ツール
注釈
Footnotes
-
公式マニュアル自動でリンクにはならないURLを一時的に書きたい場合の書き方 ↩
-
公式マニュアルclass名を自由に指定できる装飾記法 ↩