MarkDown記法でプレビュってみよう！
前置き
ちょっとしたドキュメントを作るに際して便利そうだったので導入しました。この記事ではMarkDown記法の詳しい仕様については触れていません。
気軽にかつ手軽にプレビューをしながら
ちょっとした資料を作れちゃう経緯を簡単に挙げました。
気軽にかつ手軽にプレビューをしながら
ちょっとした資料を作れちゃう経緯を簡単に挙げました。
マークダウン記法とは？
HTMLのようなタグで開いて閉じる。
このようなコーディング手法をマークアップ記法と言います。マークダウン記法はマークアップ記法の一種です。
タグ閉じなどを意識することなく軽量にHTMLなどに変換するための記述方法です。
このようなコーディング手法をマークアップ記法と言います。マークダウン記法はマークアップ記法の一種です。
タグ閉じなどを意識することなく軽量にHTMLなどに変換するための記述方法です。
例えば、HTMLで以下のような記述をする場合
|
1 2 | <h1>見出し</h1> <p>続きは<strong>Web</strong>で！</p> |
と記述するところをMarkDownだと
|
1 2 3 | # 見出し 続きは ** Web ** で！ |
となります。
なにが良いの？？
使っていて感じたメリットとしては
- 手軽にメモ帳以上のことが書ける
- 段落や見出しが必要なドキュメントに便利
- 記述量が少ない
- オンタイムでHTMLが閲覧可能
最後のプレビューに関してはvimというエディタのプラグイン機能に頼りました。
vimエディタでプレビューしてみる (準備編)
こちらの作者さまのプラグインを使用させていただきました。
一部、不足部分を追加実装させていただいちゃいました。vimが使えれば他のインストール作業などは不要です。
一部、不足部分を追加実装させていただいちゃいました。vimが使えれば他のインストール作業などは不要です。
.vimrcという設定ファイルに以下の行を追加するだけ。
|
1 | NeoBundle 'kurocode25/mdforvim' |
適当なマークダウンファイル(.mkd)を作成して編集してみます。
:MdPreview
と実行すればリアルタイムでの編集結果がブラウザで見られます。
以下のvim scriptを組み込むことで今回はチェッボックスにも対応してみました(複数不可)。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | " Convert CheckBox function! s:Convert_CheckBox(i) "{{{ let pt_st = ' \- \[' let pt_ed = '\] ' let xx = '[ x]+' if (s:line_list[a:i] =~ ("\\v".pt_st.xx.pt_ed.".*") && s:line_list[a:i] !~ ("\\v\!".pt_st.xx.pt_ed)) let l:line = s:line_list[a:i] let l:length = strlen(l:line) let l:chk_list = [] let l:forward = strpart(l:line, 0, stridx(l:line, pt_st) + 1) let l:back = strpart(l:line, strlen(l:forward)+strlen(pt_st)+1, l:length) let l:mid = strpart(l:line, strlen(l:forward)+strlen(pt_st)-2, l:length) let l:check_str = strpart(l:mid, 0, stridx(l:mid, ']')) let l:chk_str = "" if (l:check_str =~ "\\v(x)+") let l:chk_str = " checked" endif let s:line_list[a:i] = "<input type=\"checkbox\"".l:chk_str.">".l:back."</input>" endif endfunction " }}} |
Author Profile
スターフィールド編集部
SHARE
