PDS を置き場にして、URL を知っている人が読むテキスト。書く画面と表示側の一式
README.md

kamikire:a slip of paper #

English: see In English.

自分の PDS を置き場にして、URL を知っている人が読むテキストを書く道具だ。 書く画面は手元の 127.0.0.1 だけで動く。表示側は静的な HTML 1枚で、データを持たない。

力を入れているのは組版だ。仕組みは単純でいい。読ませたいのは文章だからだ。

下書き(matters/*.md)
      ↓ 書く画面の「公開」
PDS  com.example.kamikire.sheet
      ↓ getRecord は認証不要
https://example.com/kamikire/<rkey>/

原本は PDS のレコードで、表示側はそれを読んで組むだけだ。サイトを作り直しても記事は消えない。 PDS を自前に移せば記事も一緒に移る。記事はアカウントに紐付いている。

In English #

kamikire stores text in your own PDS and hands out the URL. The editor runs on 127.0.0.1. The reader is one static HTML file that holds no data. The PDS record is the original: rebuild the site and the articles survive, move to your own PDS and they move with you.

The point is typography. Japanese needs a line length of 30 to 36 characters, and mincho and gothic take opposite paragraph rules: mincho indents and closes the gaps, gothic does neither. Four layouts ship, vertical writing included. Ruby and emphasis dots use Aozora Bunko notation. Tables set smaller than the body, and short cells do not wrap, because Japanese breaks between any two characters.

Images live in your PDS as blobs. The editor shrinks each image to 1,600 px and re-encodes it as WebP, which also strips EXIF and XMP.

Sharing works by URL alone. There is no index page: anyone with the link can read, nobody can browse.

This is not privacy. PDS records are public, listRecords enumerates them, and they cross the firehose. kamikire keeps text out of sight, not out of reach. Do not use it for anything sensitive.

You need Python 3 and an AT Protocol account. Nothing else. Setup is in 始め方 below; the rest of this README is Japanese. The tools live in commons/; your drafts and settings live beside it, so updating means replacing commons/ only.

始め方 #

必要なのは Python 3 と、AT Protocol のアカウントだけだ。ほかに入れるものはない。

  1. このリポジトリを取る。zip で落としたなら、展開したフォルダの名前は kamikire など好きに替えていい
  2. commons/start.command をダブルクリックする。足りないものを道具が作る
  3. できた .env に、ハンドルと App password を書く。Bluesky 以外の PDS なら KAMIKIRE_PDS も書く
  4. .env の KAMIKIRE_SITE に、表示側の URL を書く(https://example.com/kamikire/ の形)
  5. もう一度 commons/start.command を開く。site/config.js が DID ごとできる
  6. site/ の中身を、表示側の場所へ上げる。http://127.0.0.1:8779/ で書き始められる

.env は名前が . で始まるので、Finder では隠れている。⌘⇧. で見えるようになる。

.env の KAMIKIRE_NSID には、自分の持つドメインを逆さにした名前を付ける。 com.example.kamikire.sheet のような形だ。どこにも登録しない。 PDS は知らない Lexicon を検証しないので、名前を決めればそのままレコードを置ける。

start.command を開けないときは、ターミナルでこう打てばいい。

cd kamikire/commons
python3 server.py

フォルダの形 #

道具と、書いたものを分けてある。投射モデルの形だ(同じ作者の projection-model リポジトリに説明がある)。

kamikire/
├── CLAUDE.md     説明書と現況。AI に作業を頼むと最初に読まれる
├── log.md        作業の記録
├── commons/      道具。このリポジトリの中身はここだけだ
├── matters/      下書き。一覧に出る紙切れは、公開していてもいなくてもここにある
├── piles/        片づけた紙切れと、段落を消す前などに取った控え
├── site/         表示側に置くもの。index.html・config.js・カードのページ
└── .env          設定

commons/ のほかは、初めて開いたときに道具が作る。あれば触らない。

更新する #

**commons/ だけを新しいものに替える。**書いたもの(matters/・piles/)と設定(.env・site/config.js)は commons/ の外にあるので、消えない。git で取ったなら git pull でいい。 zip なら、新しい zip の commons/ を古い commons/ と入れ替える。

替えたあとで書く画面を開くと、表示側の index.html が新しくなっていれば site/ へ写す。 そのときは「表示側へ上げてくれ」と出るので、site/index.html を上げ直す。

前の版から移す #

前の版は、道具と下書きが同じフォルダにあった。新しい版を別の場所に置き、次を打つと移せる。

python3 kamikire/commons/移す.py <前の版のフォルダ>

matters/・piles/・.env・site/config.js・カードのページを写す。 site.txt の URL は .env の KAMIKIRE_SITE へ、kamikire.py の中で直した PDS は KAMIKIRE_PDS へ移す。 **前の版のフォルダは消さない。**確かめてから自分で片づける。

書く #

書く画面には「紙面」と「MD」の2つの表示があり、⌘E で切り替える。

  • 紙面:下の欄に書き、⌘Enter で本文の末尾に足す。本文の段落を押すと、その段落を直せる
  • MD:ファイルの中身をそのまま直すテキストエリアだ。貼った文もそのまま入る

保存は入力が止まって1.4秒後だ。matters/<名前>.md にフロントマター付きの Markdown で入るので、ほかのエディタで直してもいい。外で直すと、 ウィンドウを前に出したときに読み直すかどうかを聞く。

段落を消すときと、MD で最初に打つときには、原稿の写しを piles/ に取る。 片づけた紙切れも piles/ へ移る。消えるのではなく、ここに残る。

記法 #

Markdown に、次のものを足してある。

|漢字《かんじ》       ルビ。縦棒で始めると範囲を指定できる
漢字《かんじ》         漢字の直後なら縦棒は要らない
《《ここぞ》》          傍点(ごま点)
<u>下線</u>            下線。++下線++ でもいい。縦組みでは字の右に引く
## 1.  はじめに        番号付きの見出し。番号は書いたとおりに出る
[TOC]                 目次。[[TOC]] と {{TOC}} でもいい
本文[^1]。             脚注。本文は [^1]: … と書き、紙切れの末尾に集まる

言語学の例文も書ける。番号は文書の順に振り直すので、() と書けばいい。

(1) 太郎が花子に本を渡した。
() a. 花子が太郎に本をもらった。
b. *花子を太郎を本を渡された。

括弧・数字・a. の全角と半角、後ろの空白の有無は問わない。どう書いても同じ形に組む。

表は GitHub の Markdown と同じパイプ記法だ。区切りの : で揃えを決める。 改行した行は、それぞれ段落として組む。明朝なら行ごとに1字下げる。括弧で始まる行と、例文のすぐ後ろの行は下げない。例文の後ろは空行を挟んでいても下げない。 行頭に全角の空白を置けば、その1字分だけ下がる。空行1つは段落の切れ目で、2つ目からは1つごとに1行空く。 書く画面では、空のまま ⌘Enter で返すと1行空く。&nbsp; だけの段落でも1行空く。URL をそのまま書いてもリンクになる。 目次と脚注の番号を押すと、その場所へ移る。

画像 #

書く画面の「画像」で選ぶか、欄に貼るか、欄に落とす。 画像は matters/<紙切れ名>/図1.webp に写る。入力欄では、返すまでサムネイルと ALT の欄が並ぶ。 返すと本文に ![ALT](<紙切れ名>/図1.webp) が入る。MD の欄では、置いた位置に記法が入る。

![図1 説明](<紙切れ名>/図1.webp)     画像だけの段落は図になり、[] の中が説明になる
![(a) 説明](<紙切れ名>/図2.webp)      画像の行を空行なしで続けると、横に並べる
![(b) 説明](<紙切れ名>/図3.webp)
図2 全体の説明                      画像でない最後の行は、並び全体の説明になる
  • 置いた時点で、長い辺を 1,600px までに縮め、WebP に書き出す。 **EXIF(撮った場所・時刻)と XMP は付かない。**PDS は受け取ったものをそのまま置くので、 縮めずに送ると、それらもそのまま公開される
  • ファイル名は元の名前を使わず、通し番号にする。元の名前に撮った時刻が入っていることがある
  • 公開すると、画像は PDS の blob になる。紙切れを消すと、画像も参照されなくなって消える
  • 並べるのは1段に3枚までだ。段の中は高さをそろえる
  • 読む画面では、画像を押すと拡大表示する

書く画面を通さずに置いた画像(ほかのエディタで書き込んだもの)は、縮めずにそのまま送られる。

版面 #

4つある。記事ごとにフロントマターの style で選ぶ。読者も右下の「組版」で切り替えられる。

様式 書体 行長 段落
mincho Shippori Mincho 36字 1字下げ、間を空けない
gothic Zen Kaku Gothic New 34字 字下げなし、間を空ける
ud BIZ UDPGothic 30字 字下げなし、間を空ける
tategaki Shippori Mincho 高さ次第 1字下げ、間を空けない

日本語の本の組み方と画面の組み方は違う。明朝は1字下げて段落間を空けない。 ゴシックは逆だ。同じ規則で両方を組むと、どちらかが読みにくくなる。

組版で決めたことがいくつかある。

  • 行長は30〜36字。長いと目が次の行の頭に戻りにくい
  • 明朝と縦書きでは、見出しと強調をゴシックにする。日本語の明朝の太字は本文と 見分けにくいからだ。書体が違えば差が出る。太さは上げすぎない
  • 題と副題は明朝のままにする。日本の学術雑誌の慣例と同じだ
  • 表の文字は本文より小さい。短いセル(8字まで)は折り返さない。日本語は 1文字ごとに折れるので、そのままだと「誰につい/て」と割れる
  • 縦組みでは字種ごとに向きを分ける。大文字の略語と短い数字は正立、 2桁は縦中横、長い欧文は横倒しだ

リンクカード #

URL の # より後ろは、リンクカードを作るサービスに届かない。 そのため、紙切れごとに site/<rkey>/index.html を置き、そこに題と OGP を入れる。 公開と削除のたびに自動で作る。

このページが表示側に上がっているかで、配る URL が変わる。

表示側の置き方 カードのページ 配る URL
site/ が git のリポジトリ(tangled の sites など) 公開のたびに push して上がる <表示側>/<rkey>/。貼るとカードが出る
それ以外(FTP で上げるなど) 手元の site/<rkey>/ にできるだけ <表示側>/#<rkey>。そのまま開く

FTP で上げている場合でも、site/<rkey>/ のフォルダを表示側の同じ場所へ上げればカードが出る。 上げたあとは <表示側>/<rkey>/ を配ればいい。

よそから取り込む #

leaflet・offprint・Standard・WhiteWind・pckt は、どれも自分の PDS に レコードを書いている。そのため、読み出せば手元の下書きにできる。

python3 commons/importer.py 元                     取り込める元と件数
python3 commons/importer.py 取る <公開記事の URL>    1件を matters/ へ

空の紙切れを開くと、入力欄の中に「取り込む」が出る。そこからでもいい。

本文にそのまま書かれた URL は、ページの題を取ってきて [記事名](URL)(置き場所) にする。 取り込んだ原稿には imported: の印が入る。画像は取り込まず、件数だけ知らせる。

守れないこと #

  1. 秘密は守れない。PDS のレコードは公開だ。listRecords で列挙できるし firehose にも流れる。人目に付きにくくする仕組みであって、 隠す仕組みではない
  2. 読んだ人の手元には残る。紙切れを渡したのと同じだ。消せるのは原本だけだ

機微な内容には使わないほうがいい。

コマンドで使うとき #

python3 commons/kamikire.py new matters/foo.md          組んだ結果を表示するだけ
python3 commons/kamikire.py new matters/foo.md --push   PDS へ送り、URL を出す
python3 commons/kamikire.py list                        枚数・様式・題
python3 commons/kamikire.py url <rkey>                  配る URL
python3 commons/kamikire.py rm  <rkey> --push           PDS から消す
python3 commons/kamikire.py card --push                 カードを作り直す

--push を付けない限り、PDS には書かない。送信と削除は自分で指示する。

ライセンス #

MIT。LICENSE にある。書体は各配布元のライセンスに従う(THIRD_PARTY.md)。