> ## Documentation Index
> Fetch the complete documentation index at: https://docs.markup.freddiephilpot.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Markup

Markup is a fast, keyboard-driven markdown workspace designed for structured thinking, writing, and visual knowledge organisation. It is built with **Next.js**, **TypeScript**, **PostgreSQL**, **Prisma**, **WorkOS AuthKit**, and **shadcn/ui**, and runs across both web and desktop via **Tauri**.

It combines a high-performance markdown editor with tools for exploring and connecting ideas, including graph-based navigation, whiteboards, mind maps, and real-time collaboration features.

***

## Core capabilities

* Keyboard-first markdown editor with fast navigation and editing workflows
* Live preview supporting:
  * GitHub Flavoured Markdown (GFM)
  * Mathematical expressions via KaTeX
  * Syntax highlighting for code blocks
  * Mermaid diagrams for visualisation
* Multiple workspace modes:
  * Editor
  * Split view
  * Preview-only mode
  * Graph view (backlink and relationship mapping)
  * Whiteboard mode
  * Mind map mode
* Structured file and folder system with:
  * Hierarchy support
  * Tags and pinning
  * Custom colours and icons
* Full-text search via Spotlight-style interface
* Sharing system with public and private read-only links
* Cloud-backed persistence using PostgreSQL and Prisma
* Offline-aware editing with later synchronisation
* Authentication powered by WorkOS AuthKit
* Optional desktop application using Tauri for local-first workflows

***

## Platform support

Markup is designed to run in two environments:

* **Web application** for cloud-synced, browser-based access
* **Desktop application (Tauri)** for local file integration, offline usage, and improved performance

***

## Design philosophy

Markup prioritises:

* Speed over complexity
* Keyboard workflows over mouse navigation
* Structured knowledge over flat note-taking
* Local-first editing with optional cloud synchronisation
* Extensibility for future AI and automation features

***

## Tech stack

* Next.js App Router
* TypeScript
* PostgreSQL
* Prisma ORM
* WorkOS AuthKit
* Zustand state management
* Tailwind CSS + shadcn/ui
* CodeMirror editor
* KaTeX, Mermaid, and React Markdown ecosystem
* Tauri (desktop runtime)