Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.16 KB

README.md

File metadata and controls

55 lines (33 loc) · 1.16 KB

Rauversion Documentation

Deploy Status

This is the Rauversion Documentation. Is built using Docusaurus 2, a modern static website generator.

You can read the docs at https://docs.rauversion.com

Usage

Installation

$ make install

Local Development

$ make 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

$ make build

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

Deployment

Using SSH:

$ make deploy

This command is a convenient way to build the website and push to the gh-pages branch.

Using Github Workflow:

Any push to the main branch will be compiled and sent to the gh-pages branch.

Contributors

Please, make a pull request and squash the commits before merging to main.

License