immich/docs
github-actions a04c6ed80d chore: version v1.135.2 2025-06-20 14:52:47 +07:00
..
blog
docs fix(docs): REINDEX vchord on upgrade (#19282) 2025-06-19 09:04:18 +07:00
src chore: more cursed knowledge (#18932) 2025-06-04 21:31:53 +07:00
static chore: version v1.135.2 2025-06-20 14:52:47 +07:00
.gitignore
.nvmrc chore(deps): update node.js to v22.16.0 (#18662) 2025-05-27 12:13:30 +07:00
.prettierignore
.prettierrc
README.md
babel.config.js
docusaurus.config.js docs: face lift, botox x3 (#18184) 2025-05-09 13:27:21 +07:00
package-lock.json fix(deps): revert update typescript-projects (#18908) 2025-06-03 21:13:56 +07:00
package.json fix(deps): revert update typescript-projects (#18908) 2025-06-03 21:13:56 +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

$ npm install

Local Development

$ npm 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

$ npm 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 npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm 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.