Skip to main content

Get Started


This is a demonstration of using Proxyflare to mount a documentation website on your website's /docs path.

Visit the real Proxyflare docs

A live demo build directly from this repository is deployed on which means you can start a docs site exactly like the demo out of the box.

You are viewing the latest version of the template demo and neccessary docs to help you quickly start a docs site. Try browse around this site to see the pre-configed features, full feature list can be find under Boilerplate Features

Start with this Template

To use this template, simply clone this repo or click Use This Template with your Github account.

Once cloned to your local machine,

Install dependencies


Run the development server

yarn start

Multi-languages and Search feature will not work in dev mode.

They only work in build productions.

Build the production site

yarn build

Run the build site

npm run serve

Now the site is running with full features of this template. Just like the demo on

Setup Your Own

This template has some plugins and settings pre-configured, it meets the most demands.

Continue to Quick Start to config the website for your own need.