README.md

Mentorship-Backend Docs

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

Installation

Using yarn

$ yarn

Using npm

$ npm install

Local Development

Using yarn

$ yarn start

Using npm

$ npm 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.

Build

Using yarn

$ yarn build

Using npm

$ npm run build

Serve Build

Using yarn

$ yarn serve

Using npm

$ npm run serve

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.