mirror-immich/docs
github-actions ce9b32a61a chore: version v2.6.2 2026-03-24 02:51:55 +00:00
..
docs fix(docs): clarify ML CPU architecture (#27187) 2026-03-23 18:29:58 -04:00
src feat: schema-check (#25904) 2026-02-12 17:59:00 -05:00
static chore: version v2.6.2 2026-03-24 02:51:55 +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.1 (#26275) 2026-02-17 11:45:57 +01: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
README.md chore: update docs to use pnpm (#21113) 2025-08-21 15:25:05 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js feat: doc links (#26519) 2026-02-26 12:14:17 -05:00
mise.toml fix: use wrangler cli directly (#26326) 2026-02-18 18:06:41 +00:00
package.json chore: enable prettier caching and quiet output (#26681) 2026-03-04 03:34:48 +00: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

README.md

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.