immich/docs
Claudio 90d554947f
docs: update ml-hardware-acceleration.md (#25755)
Update ml-hardware-acceleration.md

Invert the lines about editing the docker-compose.yml file to have users add the tag to the image first, then uncomment the extends section. This should help users follow the instructions as they flow through the YAML file.
2026-02-10 12:28:21 -05:00
..
docs docs: update ml-hardware-acceleration.md (#25755) 2026-02-10 12:28:21 -05:00
src docs: update documentation (#25440) 2026-01-25 15:45:30 +00:00
static chore: version v2.5.5 2026-02-06 03:49:02 +00:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 -05:00
.nvmrc chore(deps): update node.js to v24.13.0 (#25243) 2026-01-13 16:19:10 +00:00
.prettierignore ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js docs: update documentation (#25440) 2026-01-25 15:45:30 +00:00
mise.toml feat: mise monorepo tasks (#23691) 2025-11-10 15:55:15 +01:00
package.json fix(docs): add missing mermaid dependency and configuration (#25247) 2026-01-13 23:13:34 -05:00
README.md chore: update docs to use pnpm (#21113) 2025-08-21 15:25:05 -05:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js docs: update documentation (#25440) 2026-01-25 15:45:30 +00:00
tsconfig.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation (#16282) 2025-02-24 13:24:28 -06:00

Website

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

Installation

$ pnpm install

Local Development

$ pnpm run 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.

Build

$ pnpm run build

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

Deployment

Using SSH:

$ USE_SSH=true pnpm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> pnpm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.