https://github.com/goatcorp/dalamud-docs

Dalamud developer documentation site
https://github.com/goatcorp/dalamud-docs

Last synced: about 1 month ago
JSON representation

Dalamud developer documentation site

• Host: GitHub
• URL: https://github.com/goatcorp/dalamud-docs
• Owner: goatcorp
• License: mit
• Created: 2023-06-18T05:38:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T18:10:58.000Z (3 months ago)
• Last Synced: 2024-09-16T22:34:03.274Z (3 months ago)
• Language: JavaScript
• Homepage: https://dalamud.dev/
• Size: 1.48 MB
• Stars: 6
• Watchers: 3
• Forks: 21
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: news/2023-04-04-dalamud-march-updates.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dalamud Documentation

This website is built using [Docusaurus 3](https://docusaurus.io/), a modern

static website generator.

## Installation

```shell

pnpm install

```

## Local Development

```shell

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:

```shell

docker compose run workspace pnpm install

docker compose up

```

## Build

```shell

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.