Dalamud Documentation

This website is built using Docusaurus 3, a modern static website generator.

Installation

pnpm install

Local Development

Ensure that you have .NET 6 installed for DocFxMarkdownGen to work.

winget install --exact --id Microsoft.DotNet.SDK.6

Ensure that you have all of the submodules:

git submodule update --init --recursive

You will need to have the actual content built for the website to work. You can run the CI build script:

node ./ci-build.mjs

Once complete, you can start the development server:

pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Docker Development

If you want to use Docker for local dev, it's a bit cursed, but it works:

docker compose run workspace pnpm install
docker compose up

Build

pnpm build --dev

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Documentation deployment is automatic through GitHub Actions. Any doc changes on the main branch will automatically be deployed.