Outline Developer Documentation

Developer documentation for Outline, built with Docusaurus.

Live site: https://developer.getoutline.org

Prerequisites

• Node.js >= 20

Getting Started

Install dependencies:

npm install

Start the local development server (English only):

npm start

This opens http://localhost:3000 with hot-reloading enabled.

To start the dev server in a specific locale:

npm start -- --locale ru

Building

Build the site for all locales:

npm run build

Build for a single locale (much faster, useful for testing):

npm run build -- --locale en

Preview the production build locally:

npm run serve

Deployment

The site is hosted on Cloudflare Pages with the Git integration enabled. Deployment is automatic:

• Merging to main triggers a production deploy to https://developer.getoutline.org.
• Opening a pull request creates a preview deployment with its own URL.

Cloudflare Pages builds with npm run build (output in build/) on the Node version pinned in .nvmrc. There is no manual deploy step.

To verify translations locally before opening a PR:

npm run verify

English-only documents are listed in ENGLISH_ONLY in scripts/verify_translations.py. When an English rewrite leaves existing translations outdated, list the affected page and locales in OUTDATED_TRANSLATIONS. File-presence, frontmatter, and theme checks still run; content comparisons are skipped for those page/locale pairs and reported in the verification output. Remove each locale from the entry as its translation is updated, then remove the entry when all locales have caught up.