Inkstone is a self-hosted, browser-based Markdown notebook running on Cloudflare Workers, offering writing, organization, sync, and backup features.

Stars

27

7-day growth

No data

Forks

23

Open issues

0

License

NOASSERTION

Last updated

2026-07-30

AI repository intelligence
FR-AI / ANALYSIS

Why it is worth attention

It provides a complete self-hosted note-taking solution with advanced Markdown support, full-text search (including Chinese), offline queue, bidirectional links, and automated backups via WebDAV or S3—all while keeping notes as plain Markdown files.

Who it is for

  • Self-hosting enthusiasts and developers
  • Writers and researchers who prefer Markdown
  • Privacy-conscious users wanting control over their data
  • Users needing cross-device sync without third-party services

Use cases

  • Personal knowledge management with wikilinks and backlinks
  • Writing technical documentation with math, diagrams, and code highlighting
  • Syncing notes across multiple devices while offline
  • Sharing public notes with password protection and expiration

Strengths

  • Full-text search with Chinese indexing via D1 FTS5
  • Offline write queue and optimistic concurrency for reliability
  • Rich Markdown rendering including Mermaid diagrams and LaTeX math
  • Self-hosted deployment with full control over data and backups

Considerations

  • Requires a Cloudflare account and a Workers plan (free tier may have usage limits)
  • No native mobile app—browser-only interface
  • Setup requires forking the repository and configuring Cloudflare bindings
  • Backup credentials and login passwords are excluded from exports

README quick start

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

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

Data storage

ComponentPurpose
Cloudflare D1Accounts, notes, folders, tags, settings, versions, shares, and search indexes
Cloudflare R2 or Workers KVAttachment and uploaded-avatar binaries through the FILES or FILES_KV binding
Browser IndexedDBLo

Description

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

Related repositories

Similar projects matched by category, topics, and programming language.

talivia-group
Featured
talivia-group GitHub avatar

talivia

Talivia is an open-source, self-hosted analytics platform that combines web analytics, session replay, and customer revenue tracking from multiple payment providers.

Web DevelopmentData & Databases
477
TanStack
Featured
TanStack GitHub avatar

router

TanStack Router is a type-safe, data-driven React router with built-in caching, prefetching, and nested layouts, while TanStack Start extends it into a full-stack SSR framework.

Web DevelopmentFrontend Frameworks
14,861
NUber-dev
Featured
NUber-dev GitHub avatar

YTubic

YTubic is a fast, responsive, open-source YouTube Music desktop client for Windows, Linux, and macOS that uses direct InnerTube API communication and aggressive caching to provide instant navigation and playback.

Web DevelopmentFrontend Frameworks
226