immich/docs
Min Idzelis 845b0f2073
chore: use pnpm for builds (#19752)
* Migrate from npm to pnpm across entire project

• Update all GitHub workflow files to use pnpm instead of npm
• Replace npm commands with pnpm equivalents in devcontainer scripts
• Remove package-lock.json files and update to use pnpm-lock.yaml
• Consolidate node version references to use server/.nvmrc

* Refine pnpm migration based on review feedback

• Replace SKIP_SHARP_FILTERING with SHARP_IGNORE_GLOBAL_LIBVIPS environment variable
• Improve Sharp package filtering to include specific Linux architectures for Docker builds
• Optimize Dockerfile dependency caching with improved layer structure
• Clean up workspace configuration and remove redundant settings

* Address additional review feedback for pnpm migration

• Fix node-version-file paths in GitHub workflow configurations
• Refactor .pnpmfile.cjs to use switch statement for better code organization
• Correct cache type typo in fix-format workflow
• Simplify Vite configuration by merging configs inline
• Update package description for consistency

* Use 'server/.nvmrc' for fix-format.yml GHA

* Delete npm locks

* Remove Docker volume isolation for node_modules directories

• Remove volume mounts for node_modules and related directories
• Allow shared access between host and container filesystem
• Update init container to handle file ownership with conditional existence check

* Remove unused Docker volumes and volume mounts

• Remove node_modules volume mounts from devcontainer configuration
• Remove unused named volumes for pnpm-store, node_modules, and cache directories
• Clean up Docker Compose configuration after removing volume isolation

* Fix typescript-sdk package issues

• Remove unknown "build" dependency that was incorrectly added to package.json
• Update pnpm-lock.yaml to reflect dependency removal

* Add pnpm setup to mobile workflow for translation formatting

• Add pnpm action setup step to mobile unit tests workflow
• Required for translation file formatting and sorting operations

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
2025-08-19 08:55:24 -04:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs docs: vectorchord migration instructions, deprecation log on startup (#20867) 2025-08-11 16:50:48 -04:00
src feat: more cursed knowledge (#20794) 2025-08-08 10:05:59 -04:00
static chore: version v1.138.1 2025-08-18 15:23:35 +00:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 -05:00
.nvmrc chore(deps): update node.js to v22.18.0 (#20662) 2025-08-05 11:01:15 +00: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 docs: include openapi.json (#20760) 2025-08-07 12:00:50 -05:00
README.md docs: use npm in README (#9566) 2024-05-17 16:49:23 -04: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

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