Skip to main content

Introduction

This documentation website was made using Docusaurus, it is a static-site generator. It builds a single-page application with fast client-side navigation. It provides out-of-the-box documentation features but can be used to create any kind of site (personal website, product, blog, marketing landing pages, etc).

Directory structure:

Image

Adding a new documenation file

  1. Inside of the docs directory, choose the apropriate folder that your documentation should be on, and create your markdown file (.md suffix).
  2. Add the following structure in the header of your file:
---
title: <Your tile>
sidebar_position: <desired_position>
sidebar_label: <sidebar_label>
---

  1. Now, using Markdown format, write your documenation.
  2. If your documentation relies on any static asset, you can add it inside of static/images/..., and reference it inside of your markdown file with the structure: ![Image](<image_path e.g: /assets/images/---.png>)
  3. In order to implement advanced features, you can always refer the Docusaurus documentation.