Typbase

Local-first knowledge base made for Typst and the Atmosphere.

hero.mp4

Features

• Inline WYSIWYG: Compiled output replaces the source as you type. Split edit and read views come with it.
• Notebook pages: Create a page as a notebook and its source splits into cells on //% attribute lines.
• The workspace as data: #typbase.query and #typbase.page-link read pages, categories, daily notes, and sections from inside a document.
• Plugin system in Typst: Extend the app with sidebar widgets, panes, and floating windows written in the same language as your notes.
• Standalone output: Export HTML, PDF, SVG, or a compilable Typst project. The exported project is plain .typ with the library, resolved data, and plugin modules it needs.
• Local-first: Browser or desktop storage, content-addressed media, and optional sync and live collaboration through the Atmosphere. Publish a page as a public post, or publish the entire workspace as a website.

Technologies

• Nuxt 5 (nightly) for the application framework.
• CodeMirror 6 for the editor with Harper integration.
• Typst 0.15 compiled to WebAssembly for the engine.
• Loro CRDTs for collaborative editing.
• the Atmosphere with airspace for storage and sync.
• sqlite-wasm-vec and transformers.js for search.
• Tauri 3 (alpha) for desktop and mobile builds.
• pnpm and moonrepo for workspace management.

Inspirations

• Typst for the language and the idea that documents can be queried as data.
• Notion and Obsidian for the product shape: daily notes, categories, backlinks, and files on disk.
• Mnemo, the earlier Typst WYSIWYG editor whose editor and engine were extracted into Typbase.
• The LEAST Private Operating System Ever Created for reflective systems where everything is inspectable.
• Dynamic Documents as Personal Software for documents that run their own code.
• PlayBook: A Programmable Paper Notebook for programmable notebook pages.

Self-Hosting

Prerequisites

• Node 26+
• pnpm 12+
• Rust with the wasm32-unknown-unknown target.

Development

pnpm install
pnpm dev

Production

pnpm install
pnpm build
pnpm preview

Installation

You can download the latest version of the application from the GitHub Release page.

Windows (winget)

Run the following command:

winget install typbase

Arch Linux (AUR)

Install either the prebuilt package or build-from-source package from AUR:

# Prebuilt binary package
paru -S typbase-bin

# Or build from source
paru -S typbase

Void Linux

Add 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 typbase

Android

Download 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.

Updating

• 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.

License

This project is licensed under Apache-2.0. See the LICENSE file for details.