Docusaurus Starter Boilerplate (Docs Only)

This Template Is Currently Working In Progress

do not fork this repo unless you are going to contribute, this WIP is under a lot of force pushes

just clone or Use This Template

Quick start a preview

yarn
yarn build
npm run serve

WIP below

Start a new language

yarn run write-translations -- --locale fr

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.