Get Started

This is a pre-configured Docusaurus starter template for i18n docs & posts using Docusaurus v2.0.0-beta.18, Typescript, Sass, Local Search etc.

A live demo build directly from this repository is deployed on docusaurus-boilerplate.vercel.app 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

yarn

Run the development server

yarn start

info

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 https://docusaurus-boilerplate.vercel.app.

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.