Local-first knowledge base made for Typst and the Atmosphere.
hero.mp4
- Inline WYSIWYG: Compiled output replaces the source as you type, with split and read views beside it.
- Workspace queries:
#typbase.queryreads pages, categories, daily notes, backlinks, and sections, and#typbase.page-linklinks any page by id. - Notebook pages:
//%lines split a page into prose, code, log, and hidden cells. - Plugins in Typst: Sidebar widgets, panes, and windows written in the same language as your notes.
- Local-first: OPFS or native storage, content-addressed media, and optional atproto sync, collaboration, page posts, and site publishing.
- Portable output: Export HTML, PDF, SVG, or a compilable Typst project with the libraries and plugins it needs.
Typst is a document language. You write plain text with markup, math, and small programs, and Typst compiles it into PDF or HTML. Typbase treats a note as a Typst document, so pages, queries, math, exports, and plugin interfaces all share the same language.
The Atmosphere is an open network of accounts and apps built on the AT Protocol. Your account is portable instead of belonging to one app. Its data lives in a personal data server (PDS) that authorized apps can read or write, so Typbase's sync, publishing, and plugins travel with your account rather than one installation.
You can download the latest version of the application from the GitHub Release page.
Run the following command:
winget install typbaseInstall either the prebuilt package or build-from-source package from AUR:
# Prebuilt binary package
paru -S typbase-bin
# Or build from source
paru -S typbaseAdd the repository and install the package:
# Add the repository
echo "repository=https://github.com/lemueldls/typbase/releases/latest/download" | sudo tee /etc/xbps.d/typbase-repo.conf
# Install the package
sudo xbps-install -S typbaseDownload the APK from the GitHub Release page.
Most phones use arm64-v8a, older 32-bit devices use armeabi-v7a, and emulators use x86 or x86_64.
- Desktop: Checks at launch and from the "General" settings, installs in place, and restarts.
- AUR, Void, Nix: These update through your package manager.
- Android APK: Downloads the build for your device's ABI, verifies its checksum, and opens the system installer. Android asks you to allow installs from the browser or file manager that opens the APK. Typbase asks for the "install unknown apps" permission once, the first time it installs its own update.
- Engine: Typst 0.15 compiled to WebAssembly, resolves queries and turns notes into HTML, SVG, and PDF.
- Editor: CodeMirror 6 runs the Typst mode, inline frames, and autocomplete, with Harper for spellcheck.
- Sync: Loro CRDTs and airspace over the AT Protocol handle workspace docs, presence, and assets.
- Publishing: Wisp hosts the generated site, and Standard.site defines its publication records.
- Search: sqlite-wasm-vec and transformers.js provide full-text and optional vector search in the browser.
- Desktop and mobile: Tauri 3 (alpha) for filesystem access, system fonts, deep links, and the updater.
- Node 26+
- pnpm 12+
- Rust with the
wasm32-unknown-unknowntarget.
The workspace uses pnpm for packages and moonrepo for tasks.
pnpm install
pnpm devThe static app runs on its own. An optional live relay and font API proxy can also run using pnpm dev:proxy in a second terminal, and set with NUXT_PUBLIC_PROXY_URL=http://localhost:3001 if you want live rooms.
pnpm install
pnpm build
pnpm previewTo host the relay and font proxy, build the companion service separately:
pnpm build:proxy
node apps/proxy/.output/server/index.mjsSet NUXT_PUBLIC_PROXY_URL to the companion service origin when building the web app.
This project is licensed under Apache-2.0. See the LICENSE file for details.