Documentation website starter built using Docusaurus 2, a modern static website generator.
This repository is ready to be imported in Forestry, a Git-based CMS, to edit Markdown, JSON files and preview your site before saving changes.
yarn
yarn start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Copy-paste your Git repository URL, set build settings and click deploy ✨.
$ 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.