How to Build the Documentation

To begin with, first clone the repository to your machine:

git clone https://github.com/Kraken-Engine/PyKraken-Docs.git

cd into the directory:

cd PyKraken-Docs

You can build the docs either via Docker or manually.

Building with Docker

Prerequisites

• Docker — Install Docker

• Docker Compose — comes bundled with Docker Desktop (Windows/macOS). On Linux, you may need to install it separately.

  To verify you have both installed, run:

  docker --version
  docker compose version
  

Building & Running

Docker Compose will automatically build the image on first run. To force a rebuild, add the --build flag to any command below.

For local / development:

docker-compose -f docker-compose.dev.yml up

For production:

docker-compose up

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

Building Manually

This documentation site is built using Aria Docs and requires Node.js and pnpm to be installed on your system.

Prerequisites

Before you begin, make sure you have the following installed:

• Node.js v20 or newer You can verify your Node.js version with:

  node --version
  

  Or install it from here

• pnpm (recommended package manager) If you don't have pnpm in your system, you can install it from here

  You can verify the installation of pnpm by-

  pnpm --version
  

  Other package managers like npm, yarn, or bun can also be used but it is recommended to use pnpm.

Install Dependencies

Install all required dependencies using pnpm:

pnpm install

Running

For local / development:

pnpm dev

For production:

pnpm build
pnpm start

Once the server starts, you can view the documentation in your browser at:

http://localhost:3000

(If a different port is shown in the terminal, use that instead.)

Troubleshooting

• Node version issues: Ensure your Node.js version is v20 or newer. Using tools like nvm is recommended for managing Node versions.

• Dependency errors: If you're facing any dependancy issues, use pnpm and delete the node_modules folder, then reinstall:

  rm -rf node_modules
  pnpm install
  

• Still having issues? Try building with Docker instead, as it eliminates most environment-related problems. If you continue to face issues, please open a report on the GitHub Issues page.