mirror of https://github.com/immich-app/immich synced 2025-10-17 18:19:27 +00:00

History

github-actions b6223af5ca chore: version v1.140.0		2025-08-28 18:50:45 +00:00
..
blog	chore(docs): change some wording (#11201 )	2024-07-18 16:52:45 -04:00
docs	chore: faq commercial guidelines (#21320 )	2025-08-26 20:47:42 +00:00
src	feat: more cursed knowledge (#20794 )	2025-08-08 10:05:59 -04:00
static	chore: version v1.140.0	2025-08-28 18:50:45 +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	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.

$ pnpm install

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

$ pnpm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

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.