helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-10-17 18:19:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
immich/docs
History
Exact
renovate[bot] ea610760ee
fix(deps): update typescript-projects (#22809) 
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Daniel Dietzler <mail@ddietzler.dev>
2025-10-10 00:50:48 +02:00
..
docs docs: add some external library notes (#22776) 2025-10-08 12:13:41 -04:00
src docs: add Immich-Stack to community-projects (#21563) 2025-10-08 17:21:44 +00:00
static docs: update Synology install guide (#21996) 2025-10-06 21:48:39 +00:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 -05:00
.nvmrc chore(deps): update node.js to v22.20.0 (#22496) 2025-10-02 09:17:40 +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 chore: remove warning banner (#22547) 2025-10-01 21:06:22 +00:00
package.json fix(deps): update typescript-projects (#22809) 2025-10-10 00:50:48 +02: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.