🛸

Markdown Paperという選択肢

に公開
4

概要

  • Markdown Paperとは何か
  • Markdown Paperの利点
  • Markdown Paper for CLI について

Markdown Paperとは

  • Markdown形式の入力をサポートをしている、ペーパー(ホワイトボード)のようなものです
  • 例えば私はEpheというOSSを使っています
  • 思想はこちらです

利点

  • 機能的な特徴としては下記があり、これがかなり気に入っています
    • レンダリングされるわけではない
    • メモ自体を管理しない
    • 簡易的なTODO管理に向いている

レンダリングされるわけではない

  • 例えば # が視覚的にそのまま見えて思考の整理に便利です
  • # が見えていた方が良い派は一定いるのではないかと思っています

メモ自体を管理しない

  • Markdown形式のメモツールみたいなのは多数あると思います
  • それは、メモファイルを作成してそこに書いていくみたいな思想だと思います
  • そうではなく、別にものとして管理したいわけではなく、走り書きしたいという場合に非常に便利です
  • 「メモの名前をどうしよう」や「メモのディレクトリはどうあるべきか」みたいなことに脳のリソースを割くべきでないことを書きたいときに最適です

簡易的なTODO管理に向いている

  • TODOアプリで管理するようなことではないが、頭から出しておきたいTODOを管理するのに向いています
  • メモ用紙に走り書きして、線を引いていく感じです
  • - [ を打つと - [ ] に補完されます

CLIでも使いたい

  • ただ、EpheはWEBアプリなのでCLIにこもっている時にEpheが使いたいという場面に困ります
  • 最近はターミナルの中で作業することが多くなり、ターミナル中でEpheのようなものが使えたらなと思うことが多くなりました
  • Epheの作成者にCLI版を出す予定はあるか?と尋ねてみてみましたが、無さそう&任せるとご返答頂いたので作成してみました
    EpheのissueでCLI版について尋ねた際のスクリーンショット
    Epheの作者とのやり取り

CLI版を作ってみた

  • 作成したツールはaeph といいます!※ /eɪf/(1音節で「エイフ」)と読むことにします
  • npm install -g aeph してみてください
  • 名前は ephe の最後のeをひっくり返して先頭に持ってきてみました
    aeph
    aeph

demo

  • 基本的なマークダウンの入力補助を実装しています
  • Epheのようなミニマルなレンダリングやページングを実装しています
  • また、 ctrl + N でタスクの新規作成、 ctrl + T で完了・未完了を操作できます!
  • Vimライクな操作も少しだけ取り入れています!自分がよく使うものだけですが!
  • 是非、使ってみてください!
    デモ映像

Discussion

rakiraki

たぶん最後のとこ

npm install -g eaph

じゃなくて

npm install -g aeph

って書きたかったんじゃないかなって。。。

sikisiki

ありがとうございます…!大事なところを…!

yostosyostos

この記事に触発されて、自分なりのCLIツールを作りました。
紹介記事も書いたのでよろしければ見てください。

sikisiki

拝見しました!TODO特化でとても使いやすそうです!sync機能の追加検討したくなりました😆