Write markdown.
Continuously publish.

Notefig turns a folder of markdown into a published docs site. Your team writes, commits, and every change can ship itself.

The Notefig homepage: stone paper page around a framed dark editor

Files

runners.md

Custom Runners

Use your own hardware or CI systems to build and deploy books.

Why Custom Runners

  • Run builds on your own infrastructure

  • Use specialized hardware (GPU for image processing, etc.)

  • Integrate with existing CI/CD pipelines

  • Avoid usage limits on free tiers

Options

GitHub Actions: Self-hosted runners connect to GitHub repositories.

GitLab CI: Runners register with your GitLab instance.

Generic: Any system that can run shell commands. Cron jobs, webhooks, or manual triggers.

How It Works

  1. Your git server receives a push

  2. The runner triggers a build job

  3. The CLI generates static files

  4. The runner deploys to your web server

Example

A simple shell script on your server:

cd /var/books/my-book git pull notefig build rsync -av dist/ /var/www/html/

Run this manually, via cron, or triggered by a git hook.

Saved
144 words

Command Palette

Search for a command to run...

One folder of files. A live docs site.

Teams write product docs in markdown. Notefig turns that folder into a published docs site — and keeps shipping as the docs change.

Markdown editor

Syntax highlighting, live preview, and split-screen. Images, tables, code blocks, and math — written as files on disk.

Files you own

Plain markdown, no proprietary format, no lock-in. Your content stays portable no matter what you publish it as.

Git is the source of truth

Connect GitHub, GitLab, or your own remote. The editor commits and syncs so the repo is always the docs.

Publish as you write

Ship docs incrementally. Update after release. Content evolves; the published site follows the files.

One-click hosts

Deploy to Vercel, Netlify, Railway, Coolify, or S3 from the editor. Notefig writes the host config, including vercel.json.

Many projects, one app

Create and switch between projects. Each project has its own git repository and publishing configuration.

Live preview

Watch a folder of markdown and see the site as you write — in the editor or with the CLI dev server.

Deploy on push

Connect the GitHub repo to Vercel (or Netlify) and every push rebuilds the docs. Set the workflow up once.

Theming

The CLI builds a static site with a theme you choose. Override theme and output per project or per command.

For developers

Same publish path from the CLI.

Watch a folder, build static files, deploy. Drop it in GitHub Actions the same way you run it locally.

npx notefig watch
npx notefig build
npx notefig publish vercel

Start in the browser, or download for macOS.

The web app is the same editor. The desktop app talks to folders on your machine. Windows and Linux desktop are on the way.