業務日誌をマークダウンで書くか検討中
- (2022-02-26 21:34:01)
完全プレインテキストの業務日誌
現在、私の業務日誌は完全にテキストだけで書かれている。
問題ないが、画像が表現できない点がやや寂しい。
ソフト「ひとりwiki」
ネット検索している最中、偶然「ひとりwiki」というソフトを見つけた。
マークダウン記法のことは以前から名前だけは知っていた。ちょうどよい機会なので、マークダウンの効率性を試したくて使ってみた。
【YukiWiki風記法】
---------------
シングルクォート2個ではさむと''ボールド''。
* アスタリスク(*)を行頭に書くと、大見出し。
** アスタリスク(*)を行頭に書くと、中見出し。
- マイナス(-)を行頭に書くと、箇条書き。
-- 一段下のリスト
画像表示 → file://???.jpg
---------------
記法を少し覚える必要があるが、マークアップよりも簡単で、テキストだけを勢いよく打ち込むときには便利のような気がする。
しかし、少し試してみてわかったが、マークダウンで書いて便利な状況って、自分の場合あまりない。
マークダウンの限界
また、マークダウンの限界も感じた。
htmlマークアップ言語の多彩なタグと比較すると表現力は少ない。
CSSは使えるが、マークダウンのテーマが「シンプルで簡単であること」であり、デザインは割り切ろうというポリシーなのだから使わずにシンプルかつスピーディに書くべき。CSSを使う方が矛盾している。
デザインをあきらめるからこそ、 "多少構造化され装飾された文章" を、きわめて簡単に量産できる。
それでよいし、そうでなければ、マークダウンの存在意義もないと思う。
しかし、私の印象はマークダウンで装飾や構造化する、その程度の装飾や構造化なら、プレインテキストの方が扱いやすいし汎用性も高い気がする。
「改行をトル」仕様が理解できない
マークダウン記法をはじめて試して一点だけ不可解に感じたことがある。
改行コードが削除されること。htmlと同じである。
この仕様の趣旨はぼくにはわからない。
改行したければ、半角スペース2個を改行コードとして入れておけばよいとのこと。
自然なテキスト文からすれば不自然である。
テキストで制作中の業務日誌
日頃、業務日誌はテキストだけで書いている。
業務日誌に関して言えば、画像が表示できない点が、残念と思うことがある。
マークダウンなら画像も表現できるので、ここにちょっとした未練が残る。
Visual Studio Codeのマークダウン記法
昨日の「ひとりwiki」で、マークダウンの記法を少し覚えた。
このソフトでは「YukiWiki風」の記法が採用されていたが、調べるうちに、マークダウン記法にはいろいろな派生バージョンがあることを知った。
VS Code記法という記法で書いている人が多そうなので、そういうシェアの高そうなものを利用した方が、なにかと汎用性があるように感じた。
【VS Code記法】
---------------
# 見出し1
## 見出し2
**太字**
リスト
*
1. 項目1
1. 項目2
- 項目1
- 項目2
![画像](C:\Users\○○.jpg)
---------------
GitHub Flavored Markdown
たぶん、GitHub Flavored Markdownが今後のマークダウン記法の標準的な存在になりそう。
秀丸用のマークダウンマクロ
秀丸にはマークダウンをhtmlとしてプレビューできるマクロがあった:
**HmMarkDownPreview**
テキスト内に記述された画像ファイルをリアルタイムに表示してくれる。
さっそくマクロをダウンロードしてインストールしてみた。
しかし、いろいろ条件や周辺のソフトが必要で、動くまで2時間くらいかかった。
【条件や周辺ソフト】
---------------
1. 秀丸エディタ ver8.73以上
1. HmMarkDownPreview.zipをダウンロード
https://xn--pckzexbx21r8q9b.net/?page=nobu_tool_hm_markdownpreview
1. 解凍して、次のファイルをどこかにいれる
・HmMarkDownPreview.dll
・HmMarkDownPreview.mac
「HmMarkDownPreview.macをマクロ登録」して実行する
1. hm.NET v1.101以上(hm.NETの導入が必要)
x86(32bit版)とx64(64bit版)の2種類あるが、OSでなく秀丸が32bitか64bitかで選ぶ
→ 最初よく考えずに64bit版を選んで「hm.NETがありません」エラーとなった
ボクの秀丸は32bit。
1. VCRUNTIME140.dll のダウンロードとインストール
「コンピューターに VCRUNTIME140.dll がないため、プログラムを開始できません」対策
https://www.microsoft.com/ja-jp/download/details.aspx?id=48145
---------------
複数のDLLファイルを突っ込む必要があるが、秀丸のプラグイン的に動作して、しかも、案外でかいテキストファイルでもサクサクとレンダリングしてくれる。
秀丸マークダウンマクロの欠点
う~ん、なんというか、テーブルが表示されないし、リストも表示方法がおかしい。
VS Codeとは記法が微妙に違うのかな?・・原因はわからない、自分の使い方がおかしいか記法が違うようだ、とにかくプレビュー表示がおかしい。
しかし、ここまで調べて、マークダウンで書くメリットは自分にはそれほどなさそうで、モチベーションも途絶えそう。
TYPORA というマークダウンエディタ
検索しているとき、偶然、TYPORAというエディタを知る。
ダウンロードして試して驚いた。凄い!の一言。
とくに画像の挿入が、ドラッグ&ドロップでできる点はありがたい。
そして、テーブル(表作成)がめちゃめちゃ簡単、生産性が上がる予感がする。
今後マークダウンをゴリゴリ使うことになるとは思わないが、使うのであれば、 TYPORA はグッドだろう。
秀丸マクロをいまひとつ動かせない自分には使うなら TYPORA でいいんじゃないかな、と思う、有料だが。
今後の業務日誌
今後、業務日誌は TYPORA や秀丸マクロなどを使いマークダウンの可能性を検証しつつ、マークダウン記法にごく大ざっぱに従って書き、画像も含めて記録していきたい。