shuaiplus/inkstone - 仓库详情

AI 仓库情报摘要

FR-AI / ANALYSIS

为什么值得关注

它提供完整的自托管笔记解决方案，具备高级 Markdown 支持、全文搜索（包括中文）、离线队列、双向链接以及通过 WebDAV 或 S3 的自动备份功能，同时保持笔记为纯文本 Markdown 文件。

适合谁使用

自托管爱好者和开发者
偏好 Markdown 的作家和研究人员
注重隐私、希望控制数据的用户
需要跨设备同步而无需第三方服务的用户

典型使用场景

使用维基链接和反向链接的个人知识管理
编写包含数学公式、图表和代码高亮的技术文档
离线状态下在多个设备间同步笔记
分享带有密码保护和过期时间的公开笔记

项目优势

通过 D1 FTS5 实现的全文搜索（支持中文索引）
离线写入队列和乐观并发控制确保可靠性
丰富的 Markdown 渲染，包括 Mermaid 图和 LaTeX 数学公式
自托管部署，完全掌控数据和备份

使用前须知

需要 Cloudflare 账户和 Workers 计划（免费套餐可能有使用限制）
没有原生移动应用，仅浏览器界面
部署需复刻仓库并配置 Cloudflare 绑定
备份凭据和登录密码不包含在导出中

README 快速开始

Inkstone

A self-hosted Markdown notebook for writing, organizing, syncing, and backing up personal knowledge.

中文 · Contributing · LGPL-3.0-only · Demo

About

Inkstone is a browser-based notebook that runs on Cloudflare Workers. Notes always remain plain Markdown text; on top of that foundation, the application provides focused writing, live preview, full-text search, bidirectional links, offline editing, multi-device synchronization, public sharing, and off-site backups.

It is a complete self-hosted application. The deployer retains control of the database, attachments, and runtime environment.

Every new account automatically receives two standard starter notes, one in Chinese and one in English. The browser-only demo reuses the same note content; refreshing the page restores these two starter notes instead of loading a separate set of demo data.

Features

Area	Included
Writing	CodeMirror 6 editor, live preview, editor/split/preview layouts, synchronized scrolling, outline, focus mode, typewriter mode, autosave, and version history
Markdown	Tables, task lists, footnotes, definition lists, callouts, tabs, details blocks, math, Mermaid diagrams, syntax highlighting, Front Matter, and Pandoc-style attributes
Organization	Nested folders, inline tags, favorites, pinning, archive, trash, wiki links, backlinks, block references, note embeds, and a relationship graph
Search	D1 FTS5 full-text search with Chinese indexing, filters, recent notes, and command-palette navigation
Reliability	Browser-side cache, offline write queue, optimistic concurrency control, conflict copies, realtime notifications, and polling fallback
Sharing	Public note links with optional access passwords and expiration dates
Portability	JSON and ZIP exports, directly readable Markdown, attachment export, and manual or scheduled WebDAV/S3 backups
Interface	Desktop and mobile layouts, dark/light themes, accent colors, Simplified Chinese, and English

Data storage

Component	Purpose
Cloudflare D1	Accounts, notes, folders, tags, settings, versions, shares, and search indexes
Cloudflare R2 or Workers KV	Attachment and uploaded-avatar binaries through the `FILES` or `FILES_KV` binding
Browser IndexedDB	Lo

项目描述

A self-hosted Markdown notebook that runs entirely on Cloudflare Workers.

inkstone