_debris コメント機能について

overview

• _debrisのコメント機能について検討を行う
• コメント構文については以下の条件を満たすもので設計を行う
  • obsidianにて入力が容易なもの
  • ドキュメント資産の長期運用を見越した際に、死に機能になった場合削除が容易なもの
    • 今は有用だがいずれ無用になる前提で設計を行う

specifications

ビルド時にドキュメントの一部を非表示にする

%% /* %%

ビルド対象から外れる

%% */ %%

• 非公開部分をドキュメント内で指定したいシチュエーションが多々あったので実装
• CSSのコメント構文/* ... */に似せて設計（慣れているので

ビルド時にドキュメントに対してコメントを挿入する

{ text }
%% // {comment}  %%

• 自分が書いた文章に対して自己言及を行いたいときがあったので実装
  • 脚注よりもフランクな使い方
  • 使い方のバリエーションとしては以下を想定
    • 文章修正時のアップデートコメント
    • 今の自分が過去の自分に対してツッコミをいれる
• googleDocsのコメント¹的なもの
  • あくまで見た目の模倣であり、機能は皆無
• JSのコメント構文// ...に似せて設計（慣れているので
• ポイントとしてはビルド時にコメント前にあるDOM要素に対してコメントを付加できる点
  • ここがgoogleDocsっぽい

スクリーンショット

• 
• 
• いいかんじ

memo

• Obsidianのコメント記述を活用する
  • %% {text} %%
  • Markdown記法ではなくObsidian独自の仕様²なので、ドキュメント資産の長期運用を考慮する場合ちょっと微妙かもしれない
  • htmlコメント <!-- {text} --> を使うことも考えたが、エンジン次第では描画される³みたいなので、一旦は執筆環境であるObsidianのコメントを採用することとする
    • 何よりcmd + /で出せるのが一番大きい
  • grepをかける場合においても%%のほうがよさそう（な気がする）