Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

OutlineFoundation/developer-documentation

Open more actions menu

Repository files navigation

Outline Developer Documentation

Developer documentation for Outline, built with Docusaurus.

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

Prerequisites

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 deploys to GitHub Pages via:

npm run deploy

This builds all 18 locales and pushes to the gh-pages branch, which is served at https://developer.getoutline.org.

About

Documentation for Developers using Outline VPN and SDK

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.