2013/08/03(土) [n年前の日記]
#1 [prog] Markdownでドキュメントを書いてたり
ある程度プログラムができてきたので、ヘルプ相当というか、githubにアップするために必要な readme.md を ―― Markdown文書を書き始めたり。
Markdownというのは、「素のテキストファイルとして眺めても読みやすく」「HTMLその他にもサクッと変換しやすい」文書のフォーマット、とでもいうか。
常用してる xyzzy で Markdown を書けなくもないのだけど、HTML変換結果をリアルタイムプレビューをしてくれる _MarkdownPad - The Markdown Editor for Windows を使って書いてたり。ちなみに、Windows用のエディタです。Mac用ではないです。
自分で作った _markdowneditorpyqt で書いてもいいのだけど。元々、昔の MarkdownPad の動作に不満があったり、 _MarkDown#Editor が自分の環境では何故か動作に問題があったから、仕方なく自分で作ってお茶を濁してただけの話だったわけで。でも、MarkdownPad が動くなら ―― 日本語入力その他にも対応してくれているなら、そっちを使わない手はないよなあ、と。
他にも、 _Markdown Previewer というサービスを使うのも良さそうだなと。何かしらのエディタで Markdown を書いて保存するたびにリアルタイムプレビューしてくれるサービスらしくて。…サービスという分類でいいのだろうか？ そういう処理をしてくれるhtml、と呼ぶべきなのかな？ 何にせよ、自分が普段から使い慣れているエディタで、プレビューもできてしまうあたりは素晴らしいと思ったり。
Markdown というと、少し前までは、
Markdownというのは、「素のテキストファイルとして眺めても読みやすく」「HTMLその他にもサクッと変換しやすい」文書のフォーマット、とでもいうか。
常用してる xyzzy で Markdown を書けなくもないのだけど、HTML変換結果をリアルタイムプレビューをしてくれる _MarkdownPad - The Markdown Editor for Windows を使って書いてたり。ちなみに、Windows用のエディタです。Mac用ではないです。
自分で作った _markdowneditorpyqt で書いてもいいのだけど。元々、昔の MarkdownPad の動作に不満があったり、 _MarkDown#Editor が自分の環境では何故か動作に問題があったから、仕方なく自分で作ってお茶を濁してただけの話だったわけで。でも、MarkdownPad が動くなら ―― 日本語入力その他にも対応してくれているなら、そっちを使わない手はないよなあ、と。
他にも、 _Markdown Previewer というサービスを使うのも良さそうだなと。何かしらのエディタで Markdown を書いて保存するたびにリアルタイムプレビューしてくれるサービスらしくて。…サービスという分類でいいのだろうか？ そういう処理をしてくれるhtml、と呼ぶべきなのかな？ 何にせよ、自分が普段から使い慣れているエディタで、プレビューもできてしまうあたりは素晴らしいと思ったり。
Markdown というと、少し前までは、
- Mac用のMarkdownエディタしか見当たらない。
- Windows版があっても、日本語入力に難有り・インライン入力ができない。
- Webブラウザ上で記述・プレビュー表示ができるけど、一々コピーしてローカル上のエディタに貼り付けないといけない。
◎ htmlの変換には BlueFeather を使わせてもらったり。 :
_BlueFeather
BlueFeather は、Markdown → html変換ツール。Ruby製。目次を自動生成してくれたり、変換時にcss指定も挿入してくれたり、Markdown Extra + α が使えたり等、いくつか機能追加されてるツール。
ただ、独自記述が Markdown 文書内に増えてしまうので、他のMarkdown関連アプリで眺めた際に、謎文字列が表示されて、ちとアレな感じも。変換時のコマンドラインオプションで指定等できれば解決するのかもしれないけど、cssやタイトル指定はともかく、目次はどこに挿入すべきかは指定方法が思いつかない。その点、文書内でアレコレ指定するほうが使い勝手はいいのかもしれないので、判断に悩むというか。
BlueFeather は、Markdown → html変換ツール。Ruby製。目次を自動生成してくれたり、変換時にcss指定も挿入してくれたり、Markdown Extra + α が使えたり等、いくつか機能追加されてるツール。
- 目次の自動生成がなかったら、人間様が目次部分も書かないといかんわけで。それだと、絶対に見落とし・記述ミスが発生する。
- cssを自動挿入できないと、htmlに変換するたびに、毎回人間様がコピペして追加しないといけないわけで。地味に面倒臭い。
ただ、独自記述が Markdown 文書内に増えてしまうので、他のMarkdown関連アプリで眺めた際に、謎文字列が表示されて、ちとアレな感じも。変換時のコマンドラインオプションで指定等できれば解決するのかもしれないけど、cssやタイトル指定はともかく、目次はどこに挿入すべきかは指定方法が思いつかない。その点、文書内でアレコレ指定するほうが使い勝手はいいのかもしれないので、判断に悩むというか。
[ ツッコむ ]
以上です。