immich/docs
2025-09-22 02:33:20 +00:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs feat: availability checks (#22185) 2025-09-19 12:18:42 -04:00
src chore(docs): add an updated Podman/Quadlets community guide (#20744) 2025-09-16 17:05:54 +00:00
static chore: version v1.143.0 2025-09-22 02:33:20 +00:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 -05:00
.nvmrc chore(deps): update node.js to v22.19.0 (#21509) 2025-09-05 08:43:58 -04: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: face lift, botox x3 (#18184) 2025-05-09 13:27:21 -05:00
package.json chore: remove unused dependencies (#21736) 2025-09-09 20:38:17 -04: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: fix typos (#16352) 2025-02-26 17:21:27 +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.