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

• Node.js
• Yarn
• Git
• GH CLI (recommended)

Clone the repository

gh repo clone hhandika/segui

Using git:

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

Install dependencies

Install nodejs:

It is recommended to use a package manager to install nodejs. Two common options are NVM and fnm. We recommend using fnm for its speed and simplicity.

Using fnm:

curl -fsSL https://fnm.vercel.app/install | bash

After installing fnm, restart your terminal and install the latest LTS version of Node.js:

fnm install --lts

Check the installed version of Node.js:

node -v
npm -v

Activate yarn package manager:

corepack enable

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/.