Drasi documentation

This repo contains the documentation source for https://drasi.io.

Contributing

Follow the guidance in this file to learn how to contribute to Drasi's documentation.

Please review our Contributions guide prior to making contributions.

Drasi's documentation follows the Diataxis framework for its structure and content.

The documentation website is generated with the Hugo framework.

The documentation website uses the Docsy theme. Refer to the Docsy authoring guide for helpful tips on creating content.

Building the docs

You can use the pre-configured dev container for this repository in Visual Studio Code or GitHub Codespaces.

Alternatively, you can follow the instructions below to setup and run a local Hugo server to edit and view your changes.

Pre-requisites

• Node.js

Setup Hugo and Docsy

1. Install Hugo

2. Clone the drasi-project/docs repo

3. The Docsy theme is configured as a submodule which needs to be pulled. From the root of the drasi-project/docs repo (where this readme is located) run:

   git submodule update --init --recursive --remote

4. Switch to the Docsy theme folder:

   cd docs/themes/docsy

5. Build the Docsy theme by running:

   npm install

Run the Hugo server

1. Ensure you are in the docs folder of the drasi-project/docs repo.

2. Run the command:

   hugo server --disableFastRender

Browse the documentation

The documentation website will be accessible on the URL http://localhost:1313/

Code of Conduct

Please refer to Drasi's Community Code of Conduct.