1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-27 10:58:13 +02:00
immich/docs
Ben McCann c50241369a
docs: link to storage label docs from storage template docs (#8911)
* docs: link to storage label docs from storage template docs

* docusaurus sucks
2024-04-18 21:08:09 -04:00
..
blog feat(docs): New repair and statistics pages (#8030) 2024-03-23 19:43:10 +00:00
docs docs: link to storage label docs from storage template docs (#8911) 2024-04-18 21:08:09 -04:00
src add community project PSImmich (#8851) 2024-04-16 18:01:56 +00:00
static docs: community projects (#8641) 2024-04-09 07:03:25 +02:00
.gitignore
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js Docs: minor changes (#8814) 2024-04-16 07:26:12 +02:00
package-lock.json fix(deps): update typescript-projects (#8834) 2024-04-16 17:45:14 -04:00
package.json deps: update docs (#6462) 2024-01-17 22:44:45 -05:00
README.md Docs: minor changes (#8814) 2024-04-16 07:26:12 +02:00
sidebars.js
tailwind.config.js
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

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