Sarufi Documentation Website

The Sarufi documentation website is built using Docusaurus 2, a modern static website generator. Contributions are welcome.

Getting Started

For small changes, fork the repository, edit it on GitHub and make a pull request.

For more extensive changes:

• fork the repository
• clone your fork onto your local machine
• make your changes
• preview your changes using yarn
• once satisfied with your changes, push to your fork and make a pull request

Installation

git clone https://github.com/YOUR_USERNAME/sarufi-docs
cd sarufi-docs
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.