0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-02-11 01:18:24 -05:00
immich/docs
Nicholas Flamy 3f18acdb1a
docs: TrueNAS: add danger message to external libraries (#15857)
Add danger message to external libraries in truenas.md (Format fix included)
2025-02-02 12:07:39 -06:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs docs: TrueNAS: add danger message to external libraries (#15857) 2025-02-02 12:07:39 -06:00
src feat: merch links (#15843) 2025-02-02 00:26:23 +01:00
static chore: version v1.125.7 2025-01-29 17:41:38 +00:00
.gitignore
.nvmrc chore(deps): update node.js to v22.13.1 (#15503) 2025-01-21 16:16:46 -06:00
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js feat: merch links (#15843) 2025-02-02 00:26:23 +01:00
package-lock.json fix(deps): update typescript-projects (#14892) 2025-01-22 22:15:38 +00:00
package.json fix(deps): update typescript-projects (#14892) 2025-01-22 22:15:38 +00:00
README.md docs: use npm in README (#9566) 2024-05-17 16:49:23 -04:00
sidebars.js
tailwind.config.js feat(doc): new homepage design and font (#13084) 2024-10-03 13:33:36 +07:00
tsconfig.json fix(deps): update docs (#7068) 2024-02-13 14:07:16 +00: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.