cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-16 02:18:50 -07:00
Code Issues Packages Projects Releases Wiki Activity
1efcac0946
immich/docs
History
Jason Rasmussen 5a792cc821
chore(docs): spelling (#1081)
2022-12-09 18:39:50 -05:00
..
blog Added v1.36 release note to website 2022-11-21 12:53:25 -06:00
docs chore(docs): spelling (#1081) 2022-12-09 18:39:50 -05:00
src Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
static Update documentation 2022-11-08 14:22:42 -06:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js Add generated openapi docs to website (#1067) 2022-12-07 21:57:34 -06:00
package-lock.json Add generated openapi docs to website (#1067) 2022-12-07 21:57:34 -06:00
package.json Add generated openapi docs to website (#1067) 2022-12-07 21:57:34 -06:00
README.md Change documentation folder to docs 2022-10-27 21:44:37 -05:00
sidebars.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
tsconfig.json Change documentation folder to docs 2022-10-27 21:44:37 -05:00

README.md

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.