1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-25 10:43:13 +02:00
immich/docs
renovate[bot] 59d6af54c7
chore(deps): update node.js to v22.12.0 (#14650)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-12-12 10:12:44 -06:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs chore(docs): stronger discouraging of non-Linux installations (#14620) 2024-12-10 16:42:45 -05:00
src chore(docs): add Kodi plugin for Immich to the Community Projects list (#14586) 2024-12-10 15:58:14 -06:00
static chore: version v1.122.3 2024-12-11 21:15:03 +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(deps): update node.js to v22.12.0 (#14650) 2024-12-12 10:12:44 -06: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

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.