immich/docs
2026-02-26 12:14:17 -05:00
..
docs feat: doc links (#26519) 2026-02-26 12:14:17 -05:00
src
static feat: doc links (#26519) 2026-02-26 12:14:17 -05:00
.gitignore
.nvmrc
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js feat: doc links (#26519) 2026-02-26 12:14:17 -05:00
mise.toml
package.json
README.md
sidebars.js
tailwind.config.js
tsconfig.json

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.