mirror of https://github.com/immich-app/immich.git synced 2026-01-15 06:23:00 -08:00

Files

Ben c7254a0c30 fix(docs): add missing mermaid dependency and configuration (#25247 )

* fix(docs): add missing mermaid dependency and configuration

* fix: include pnpm-lock.yaml

* fix: docusaurus config format issue

2026-01-13 23:13:34 -05:00

docs

feat: Cleanup docs (#25223 )

2026-01-12 13:50:02 -06:00

src

feat(web): 2026 font (#25174 )

2026-01-13 18:19:09 +00:00

static

feat(web): 2026 font (#25174 )

2026-01-13 18:19:09 +00:00

.gitignore

docs: include openapi.json (#20760 )

2025-08-07 12:00:50 -05:00

.nvmrc

chore(deps): update node.js to v24.13.0 (#25243 )

2026-01-13 16:19:10 +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

fix(docs): add missing mermaid dependency and configuration (#25247 )

2026-01-13 23:13:34 -05:00

mise.toml

feat: mise monorepo tasks (#23691 )

2025-11-10 15:55:15 +01:00

package.json

fix(docs): add missing mermaid dependency and configuration (#25247 )

2026-01-13 23:13:34 -05: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

README.md

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.