immich/docs
github-actions 45a0315606 chore: version v2.3.0 2025-11-19 17:46:53 +07:00
..
docs feat(server): support running medium tests in devcontainer (#23882) 2025-11-18 21:03:21 +07:00
src feat: move community projects and guides to immich-aweseome (#23016) 2025-10-17 10:00:28 +07:00
static chore: version v2.3.0 2025-11-19 17:46:53 +07:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 +07:00
.nvmrc chore(deps): update node.js to v24 (#23346) 2025-10-29 14:48:20 +07:00
.prettierignore
.prettierrc
README.md chore: update docs to use pnpm (#21113) 2025-08-21 15:25:05 +07:00
babel.config.js
docusaurus.config.js chore: remove warning banner (#22547) 2025-10-01 21:06:22 +07:00
mise.toml feat: mise monorepo tasks (#23691) 2025-11-10 15:55:15 +07:00
package.json chore(deps): update node.js to v24 (#23346) 2025-10-29 14:48:20 +07:00
sidebars.js
tailwind.config.js docs: fix typos (#16352) 2025-02-26 17:21:27 +07: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 +07: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.