Civo Documentation

This repository serves as the source for Civo documentation. The source files in the repository are used to render the documentation pages at https://www.civo.com/docs .

You can contribute to this repository by submitting a Pull Request with your suggested changes. Once merged to the main branch, these changes will be reflected on the site. Read our contributing document for more detail.

Website

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

Installation

You will need Yarn installed, which in turn requires npm and Node. On a Mac using homebrew, you can run brew install node.

Assuming you have npm set up, you can run:

npm install --global yarn

Then run

$ 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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.