c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-29 15:11:58 +00:00
Code Releases Activity
immich/docs
History
Alex Tran 2782dae518
doc: Added contribution guide line
2022-11-03 22:26:09 -05:00
..
blog Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docs doc: Added contribution guide line 2022-11-03 22:26:09 -05:00
src doc/update overview section (#904) 2022-10-31 06:37:36 -05:00
static docs: add installation section (#912) 2022-11-01 20:01:03 -05:00
.gitignore Change documentation folder to docs 2022-10-27 21:44:37 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js doc: Added contribution guide line 2022-11-03 22:26:09 -05:00
package-lock.json Change documentation folder to docs 2022-10-27 21:44:37 -05:00
package.json Change documentation folder to docs 2022-10-27 21:44:37 -05: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.