1
0
mirror of https://github.com/immich-app/immich.git synced 2024-11-28 09:33:27 +02:00
immich/docs
2024-01-17 22:37:48 -05:00
..
blog docs: recap 2023 (#5665) 2023-12-13 03:03:15 +00:00
docs feat(server): provide the ability to search archived photos (#6332) 2024-01-18 02:08:00 +00:00
src fix(web): use env for web folder path (#5753) 2023-12-16 11:15:30 -06:00
static docs: fix redirects for cloudflare (#5734) 2023-12-15 15:20:50 -06:00
.gitignore
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js refactor: open api (#6334) 2024-01-12 07:36:27 -05:00
package-lock.json fix(deps): update docs (#6420) 2024-01-16 09:27:04 -05:00
package.json docs: remove tsc check (#6464) 2024-01-17 22:37:48 -05:00
README.md
sidebars.js
tailwind.config.js docs: add sponsor link (#5597) 2023-12-09 20:59:00 -06:00
tsconfig.json

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

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

$ yarn 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.