How to Publish the Website

The website uses Docsify — a client-side documentation renderer. There is no build step: Docsify runs entirely in the browser and loads Markdown files directly.

The site is hosted on GitHub Pages and served from the docs/ folder of the repository. The docs/.nojekyll file tells GitHub Pages to skip Jekyll processing.

Prerequisites

You need Node.js installed on your machine (it includes npm and npx).

To check whether Node.js is already installed, run:

node --version
npm --version

If either command fails, download and install Node.js from nodejs.org (LTS version recommended). No additional global install is required — the npx command (bundled with npm) will download Docsify on demand when you run it for the first time.

Running the Website Locally

During development, serve the website locally using the Docsify CLI:

npx docsify-cli serve docs

The site will be available at http://localhost:3000 and will automatically reload on file changes.

Alternatively, any static file server works (e.g. npx serve docs). Do not open docs/index.html directly in a browser — Docsify relies on HTTP requests to load Markdown files, so a server is required.

Deploying Changes

Once development is complete:

1. Push your branch to the repository.
2. Create a pull request to merge it into the master branch.
3. Once merged, GitHub Pages automatically serves the updated content from the docs/ folder — no CI/CD step is needed.