Skip to content

Instantly share code, notes, and snippets.

@azu

azu/proposal.md Secret

Last active Jan 2, 2021
Embed
What would you like to do?
[Proposal] A Private memo app based on GitHub → Create https://github.com/azu/hubmemo

目的

  • GitHubリポジトリにファイルベースのメモアプリ
  • プライベートでどこからでも投稿できるメモアプリ
  • Twitterをメモアプリとして使うような感覚で利用できるもの
    • ショートカットの共有から投稿が可能な形
  • 追記をベースとしたストリームタイプのメモ
    • 編集はコストを高めにして、追加をできるだけ簡単にするデザイン

https://excalidraw.com/#json=5058663475576832,PfCDDy-kmAaJQulJ4P4NrA

特徴

  • GitHubリポジトリにはファイルベースのメモが残る
  • タイムライン的なメモの振り返りができる
  • インクリメンタルによる高速な検索
  • アクセスコントロールを持ったプライベートなメモ

構成要素

  • 投稿クライアント: gitリポジトリに特定の構造でファイルをpushするクライアント
  • ビルダー: GitHubの特定の構造からサイトを作る仕組み
    • 保存されたファイルを上手くbundleして検索Indexの作成
    • 経験的には 10年ぐらいのメモデータをJSONにしても数MB程度なので、JSONにするだけ十分
    • https://jser.info/source-data/items.json
  • ビューア: 高速なファイル検索
    • 検索Indexをベースとしてファイル検索
    • 経験的にはWebWorkerでJSONを検索するだけで体験は十分よい
    • hatebupwa

ファイルの形式

パラメータ

  • path
  • text
  • img(s)

pathにファイルがあるなら追記、 pathにファイルがないなら作成。

ファイルとは

  • ${path}/README.md
  • ${path}/img/{img-name}

として保存する。

📝 フラットに保存するとGitHubウェブ上で負荷が高い。フラット化はビューアで行う。

コンテンツ

Markdown + yamlの形式

---
created: <date>
modified: <date>
---

<text>

<img>

<img>

----

追記の<text>

<img>

<img>


関連

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment