immich/docs
2026-02-02 15:06:40 +01:00
..
docs Source Code added 2026-02-02 15:06:40 +01:00
src Source Code added 2026-02-02 15:06:40 +01:00
static Source Code added 2026-02-02 15:06:40 +01:00
.gitignore Source Code added 2026-02-02 15:06:40 +01:00
.nvmrc Source Code added 2026-02-02 15:06:40 +01:00
.prettierignore Source Code added 2026-02-02 15:06:40 +01:00
.prettierrc Source Code added 2026-02-02 15:06:40 +01:00
babel.config.js Source Code added 2026-02-02 15:06:40 +01:00
docusaurus.config.js Source Code added 2026-02-02 15:06:40 +01:00
mise.toml Source Code added 2026-02-02 15:06:40 +01:00
package.json Source Code added 2026-02-02 15:06:40 +01:00
README.md Source Code added 2026-02-02 15:06:40 +01:00
sidebars.js Source Code added 2026-02-02 15:06:40 +01:00
tailwind.config.js Source Code added 2026-02-02 15:06:40 +01:00
tsconfig.json Source Code added 2026-02-02 15:06:40 +01: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.