1
0
mirror of https://github.com/immich-app/immich.git synced 2024-11-24 08:52:28 +02:00
immich/docs
2023-06-19 16:42:59 -05:00
..
blog
docs move public msg to general section (#2864) 2023-06-19 16:42:59 -05:00
src
static
.gitignore
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js
package-lock.json fix(deps): update dependency tailwindcss to v3.3.2 (#2808) 2023-06-16 17:14:29 +00:00
package.json chore(deps): update dependency typescript to v5 (#2795) 2023-06-16 10:43:40 -05:00
README.md
sidebars.js
tailwind.config.js
tsconfig.json
vercel.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.