Skip to main content

Building SEGUL Documentation

SEGUL documentation is built using docusaurus and deployed using Vercel. The documentation is written in markdown and the website is built using React written in TypeScript.

Prerequisites

Clone the repository

gh repo clone hhandika/segui

Using git:

git clone https://github.com/hhandika/segui.git

Install dependencies

Install nodejs:

First, intall nodejs by following the instructions here

We recommend using yarn to install the dependencies:

npm install -g yarn

Change directory to the website folder:

cd segui/website

Install docusaurus dependencies:

yarn install

Run the website

To run the website locally, use the following command:

yarn start

The website will be available at http://localhost:3000/.