Dalamud Documentation

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

Installation

pnpm install

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.

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

pnpm build

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

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

Name		Name	Last commit message	Last commit date
Latest commit History 88 Commits
.github/workflows		.github/workflows
.husky		.husky
api_versioned_docs/version-placeholder		api_versioned_docs/version-placeholder
api_versioned_sidebars		api_versioned_sidebars
docs		docs
news		news
src/components		src/components
static		static
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
.remarkrc.js		.remarkrc.js
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
api_versions.json		api_versions.json
babel.config.js		babel.config.js
ci-build.mjs		ci-build.mjs
custom.css		custom.css
default-sidebars.js		default-sidebars.js
dfmg-config.yml		dfmg-config.yml
docker-compose.yml		docker-compose.yml
docusaurus.config.js		docusaurus.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json