PlainShelf is a local-first personal reading library for plain text books.
翻譯準備中
取自儲存庫 README
正在載入完整 README。 以下為已儲存的摘錄。
PlainShelf is a local-first, single-user reading library for lightweight text
content. It stores the library in human-readable files and provides web,
desktop, and experimental Android clients. Local-first is also a security
stance: no platform — including this one — holds your library or your reading
records, and no PlainShelf server holds your credentials. See
Deployment and threat model for what each
deployment does and does not protect.檢視完整 README ↗PlainShelf is a local-first, single-user reading library for lightweight text content. It stores the library in human-readable files and provides web, desktop, and experimental Android clients. Local-first is also a security stance: PlainShelf operates no service that holds your library, reading records or credentials. Your own server or device reads the credentials needed for the remote sources you configure. See Deployment and threat model for what each deployment does and does not protect.
Before 1.0: the on-disk format freezes at
1.0.0-rc1— from that release on, the shelf's user-data files take only backward-compatible changes. Until then a 0.x upgrade can still change them, and the HTTP API and UI stay changeable either way. Back up your shelf before upgrading — see Backup and restore for what to copy and how to put it back, and Data format versioning for what the on-disk format does and does not guarantee.
PlainShelf is not a Calibre replacement. PDF, comic archives, DRM, OCR, multi-user accounts, cloud sync, public sharing, and plugins are outside the current scope. The Android client can read a shelf held on pCloud, but that is a read-only storage backend, not sync: nothing is written back.
EPUB is an import format, not a storage format: the text is extracted and stored
as an ordinary plain-text or Markdown book, and the original .epub is not kept.
EPUB import covers what survives the conversion, including
the illustrations a Markdown import keeps.
Open the demo: the full web app running in your browser, with nothing to install and nothing uploaded. See Try the demo for where it keeps your library and how to move a library between it and a real install.
On Apple Silicon macOS:
brew install --cask voilelab/plainshelf/plainshelf
Prebuilt server archives and Docker images are also available. See the installation guide, then follow Getting started.
npm --prefix frontend ci
npm --prefix frontend run build
go test ./...
The Go server embeds frontend/dist, so build the frontend before running Go
builds or tests. Full setup, desktop, mobile, Docker, and test instructions are
in the development guide.