markdownに関する補足

kramdownについて

• kramdown コマンドでの変換：

  動作形態

  kramdownコマンド文法概要

  図のようにkramdownコマンド単体の（デフォルトの）動作は、

  • markdown を標準入力から入力し、
  • 変換によって作られた htmlを、標準出力に出力する。

• ファイルからファイルへの変換のときは、

  リダイレクト	<	（入力ファイル）	>	（出力ファイル）
  オプション	-i	（入力ファイル）	-o	（出力ファイル）

  といった記法で入力元や出力先を指定できる。

• md を rakeで変換するために、 第６回に紹介した rakefile.rb に書き足すといいルールでは、

      sh "kramdown #{t.source} > #{t.name}"
  

  という呼び方で変換させたが、
  kramdown コマンドのオプションによる入出力の指定方法を用いて、以下のように書いてもいい。
  

  ターゲット名の衝突

  • 注意：右図のように同じ名前の拡張子違いの（.mdと .slim）があると、あとで編集された側が.htmlに変換され、古いほうに対応する.html は消去される。
    （ソースがあるので実害がないが）混乱をさけるためには、 .md と .slim に同じ名前をつけないよう ファイル名にルールを設けるなどして管理するといい。

タブ数の制限

MarkdownPad2 について

• MarkdownPadにはフリー版とPro版（有償）があり、フリー版はいくつかの機能制限がある。
  • 例えば同時に編集できるファイルの数は最大４つ
    （５つめを開こうとすると右のようなメッセージが出る。 が、MarkDownに慣れるまではヘビーな使い方はしないだろうから、おそらく当面はフリー版で十分だろう）

• MarkdownPadを含むmarkdown編集ソフト（オンライン版でも） 　 左側がソース（MarkDown)、右側がプレビュー画面という構成

  構成

  • 右図のように内部でHTML自動的に変換してそのデータを DOMに似たものとしてプレビューのために保持している。　
  • その過程で（オプションで指定される）CSSファイルも参照する。
• 前述の内部HTMLデータ構造を取り出して、 MarkDownPad2で作成した文書をHTMLに変換する方法として、 （外部ツールを使わない方法としては）２つある。
  1. ファイルメニューから「エクスポート」：
     • このときはソースファイルと同じ場所（フォルダ）に に 同じファイル名でエクスポートすればいい（拡張子は違うものになる）。
     • ただし、現在有効になっているCSSファイルの内容が 出力HTMLのscriptタグ内に展開されてしまうため、 長いファイルになってしまう。

  2. 編集メニューで「HTML文書としてコピー」：

     メモ帳に貼付け

     • この場合、そのHTMLテキストをエディタ画面に貼り付けて 保存するなどの操作が必要となる。
     • そのとき、先頭に <doctype html>を 挿入しておくことが望ましい
     • メモ帳に貼り付けると、改行文字を一様にWindows流のやりかたで扱ってしまい右図のように 構造が読み取れないHTMLになってしまうので、 せめて TeraPad以上の機能のエディタを使うといい。

箇条書きの文法

MarkDownの文法

• Markdownでは、文書構造を示す記号はすべて半角の英数字か特殊文字（* + - # など）
• その間に入ったり行頭に入ったりするスペースも、 半角である必要がある。
  • スペースはエディタの画面上で半角と全角の区別がつけづらいので特に注意を要する。
  • TeraPadの場合は、スペースを区別して表示するオプションがあるのでそれを有効にしておくといい。

拡張の現状

• Markdownは右図のように元来の仕様と、それに対して 拡張された仕様から成り、 処理系ごとにいくつかの互いに非互換な拡張も存在している。
  • Markdownユーザはどの処理系でどの仕様に基いて記述するかを 適宜選択する必要がある。
  • MarkDownPad Proでは、いくつかの拡張仕様への対応が 含まれているが、フリー版では基本仕様のみ。

  • 本科目では後述のKramdownでの拡張（MarkDownPad2 のプレビューには正しく表示されないが）は後で いくつか紹介する予定。

    表の文法

    基本仕様にない機能

  • 基本仕様で扱えない機能として以下のようなものがある。
    1. 要素にクラス名やid名を付与
    2. table要素を簡易に書く文法(右のように縦棒で区切る)

キー操作

• MarkDownPadは、タブエディタ。

重要なショートカット

• 新規ファイル作成や、タブを切り替える操作をマウスで行っていると 余分な手間となる。
• こういった操作はキーボードショートカットで手早く行える ようにしておこう（右図参照）。
• これらのキーは、タブブラウザなどタブで画面を切換る 使い方の多くのソフトウェアで共通のものになっている。

kramdown(MarkDown）と テンプレートエンジン Slim

slimとmd

• どちらも簡便な文法で書いたものをHTMLに変換して使うためのもの
• 用途が重なる２つの道具、であるようにも見えるが、実際には 元来の使用目的が違っている。
  • markdownは原稿書き
  • テンプレートは文書やページの構造を作る

• なので場面に応じて、使い分ければいい。

  入れ子にして使う

• また、図のようにSlimの中にmarkdownによる記述を ブロックとして差し挟むことで、 １つのファイル内での混在も可能。
  • Slimにmarkdown用の適切な組込エンジンがインストール されていることが条件となるが、
  • kramdownが組込エンジンとして機能する。