TypstDrive

TypstDrive is a self-hosted place to write, organize and share Typst documents in your browser. Write on one side, see the finished pages on the other, and work on the same document with other people at the same time.

Note

TypstDrive is a community project. It is not affiliated with, endorsed by, or supported by the official Typst project. It uses the open-source Typst compiler, and links to Typst documentation and Typst Universe open the official Typst website. Please report problems on the TypstDrive issue tracker.

Full documentation, including a user guide, self-hosting, administration and the API reference, is at sirblobby.github.io/TypstDrive.

Features

Writing

• Live Preview: Pages update as you type, with zoom and a preview pane you can collapse.
• Editor: Syntax highlighting, autocompletion, inline errors, auto-closing brackets and smart features from the tinymist language server.
• Formatting Toolbar: Headings, bold, italic, code, quotes, math, lists, a font picker and page settings.
• Quick Insert: Images, tables, other documents, symbols and emoji.
• Find and Replace, line comments and a spell checker that skips code and math.
• Customizable Keybinds: Change the editor shortcuts and spot conflicts at a glance.
• Editor Settings: Font, font size, line numbers and a minimap.

Working Together

• Real-Time Collaboration: See other people's changes and cursors instantly.
• Comments: Comment on text, reply, and resolve or reopen threads.
• Suggestions: Propose edits for others to accept or reject.
• Version History: Automatic and manual versions, a timeline of who edited, side-by-side changes and one-click restore.

Organizing and Sharing

• Drive: Folders with custom colors, search, sorting, grid and list views, stars and file previews.
• Projects: Multi-file workspaces for books, theses and templates, downloadable as a ZIP.
• Packages: Publish a project as a package everyone on your server can import, with private packages for people and teams.
• Fonts and Images: Upload once and use everywhere, with an emoji font built in.
• Sharing: Share documents, projects and folders as editor, suggester or viewer, and hand over ownership.
• Share Links: Let anyone with the link view, suggest or edit, with an optional password and expiry date.
• Team Spaces: Shared drives owned by a team, with owner, admin, member and viewer roles.
• Import: Turn Word, LaTeX, Markdown and HTML files into Typst documents.

Finishing

• Export: PDF, PNG, SVG and Typst source, plus Word, Markdown, LaTeX and HTML through Pandoc.
• Presentation Mode: Full-screen slides with a slide overview, timer, progress bar, laser pointer, pen, highlighter and eraser.
• Render API: Turn Typst into PNG, PDF or HTML from your own code, with scoped keys, rate limits and usage charts.
• Typst Desktop: Keep documents on your computer and in sync with the Typst Desktop app.

Accounts and Administration

• Sign-In Options: Passwords, one-time email codes, Google, GitHub and any OpenID Connect provider such as Keycloak, Authentik or Authelia.
• Account Security: Email verification, password reset, active sessions, connected accounts and sign-in lockout.
• Themes: Cerberus, Catppuccin and Arch Linux themes in light and dark mode, plus text size and high contrast options.
• Branding: Your own site name, logo, accent color, tagline and sign-in message.
• Admin Tools: Users, registration rules, sign-in methods, email testing, team limits, storage quotas, version history limits, package rules, API limits and an audit log.
• Flexible Hosting: SQLite, PostgreSQL or MySQL/MariaDB with automatic upgrades, plus Redis or Valkey and S3-compatible storage for larger installs.

Future Features

• [] Add language support for more languages.
• [] Add more themes or maybe allow users or site admins to upload new themes.

Self-Hosting

TypstDrive runs as a single Docker container.

1. Generate a secret that keeps people signed in across restarts:

   openssl rand -hex 64

2. Save this as docker-compose.yml and paste the secret into COOKIE_SECRET:

   services:
     typstdrive:
       image: ghcr.io/sirblobby/typstdrive:latest
       container_name: typstdrive
       restart: unless-stopped
       ports:
         - "3000:3000"
       environment:
         - COOKIE_SECRET=paste-your-secret-here
         - PUBLIC_URL=http://localhost:3000
         - RUST_LOG=info
       volumes:
         - ./data:/data

3. Start it:

   docker compose up -d

4. Open http://localhost:3000 and create the administrator account on the setup page.

Everything is stored in ./data, so that is the folder to back up. To update, run docker compose pull and docker compose up -d; the database is upgraded automatically.

Before opening TypstDrive to the internet, put it behind a reverse proxy with HTTPS and set PUBLIC_URL to your domain. The documentation covers each step:

• Install with Docker
• HTTPS and reverse proxies
• Updates and backups
• Databases
• Sign-in and single sign-on and email
• Settings reference

Documentation

• Your first document
• User guide
• Self-hosting
• Administration
• API reference
• Contributing

License

TypstDrive is released under the Apache License 2.0.

TypstDrive uses the Typst compiler, which is also released under the Apache License 2.0.

Disclaimer

TypstDrive is a community application and is not affiliated with, endorsed by, or supported by the official Typst project. "Typst" is used only to describe the document language TypstDrive works with. Links to Typst documentation and Typst Universe open the official Typst website.

Previews

Donate

If you like this project, consider donating to me. It will help me to maintain this project and make more projects like this.
As a broke college student, every donation goes straight to the important things: textbooks, energy drinks, and upgrading my diet from instant ramen to slightly more expensive instant ramen.

test