0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-28 00:59:18 -05:00
immich/docs
Matthew Momjian 4d6d5537b7
fix(docs): discourage docker desktop (#15020)
* discourage docker desktop

* callout *nix OS as supported

* change order, clarify mac
2025-01-01 19:58:53 -05:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs fix(docs): discourage docker desktop (#15020) 2025-01-01 19:58:53 -05:00
src fix(docs): month (#15024) 2025-01-01 18:34:01 -06:00
static chore: version v1.123.0 2024-12-17 16:00:50 +00:00
.gitignore
.nvmrc chore(deps): update node.js to v22.12.0 (#14650) 2024-12-12 10:12:44 -06:00
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js feat(doc): new homepage design and font (#13084) 2024-10-03 13:33:36 +07:00
package-lock.json fix(deps): update typescript-projects (#13939) 2024-11-21 14:07:06 +00:00
package.json chore: update deps (#14755) 2024-12-18 14:19:48 +00:00
README.md
sidebars.js
tailwind.config.js feat(doc): new homepage design and font (#13084) 2024-10-03 13:33:36 +07:00
tsconfig.json

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.