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

cli.md

CLI

The Notefig CLI converts markdown files into static websites. It handles building, theming, and deployment.

Installation

npm install -g notefig

Or use npx without installing:

npx notefig <command>

Commands

init: Create a new project

notefig init

watch: Start development server

notefig watch

build: Generate static site

notefig build

publish: Deploy to hosting platform

notefig publish vercel notefig publish netlify notefig publish s3

Configuration

The CLI reads .metristsrc for settings:

{ "theme": "default", "output": "dist", "title": "My Book" }

CI/CD Integration

The CLI works in any CI environment. Example GitHub Actions workflow:

- name: Build book run: npx notefig build - name: Deploy run: npx notefig publish vercel

Global Options

  • --config <path>: Specify config file location

  • --theme <name>: Override theme

  • --output <dir>: Override output directory

  • --verbose: Detailed logging


Saved
154 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.