self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-25 10:43:13 +02:00
Code Issues Releases Activity
99da181cfc
immich/docs
History
Coyote6705 948ff5530c
Grammar and syntax edits for the new docs (#936) 
* Update introduction.mdx

* Update logo-mearning.md

* Update support-the-project.md

Fixing more grammar/syntax :)

* Update one-step-installation.md

* Update recommended-installation.md

* Update requirements.md

* Update automatic-backup.md

* Update bulk-upload.md

* Update post-installation.md

* Update update.md

* Update contribution-guidelines.md
2022-11-06 21:27:14 -06:00
..
blog Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docs Grammar and syntax edits for the new docs (#936) 2022-11-06 21:27:14 -06:00
src Switched hero image to webp 2022-11-05 20:42:26 -05:00
static Switched hero image to webp 2022-11-05 20:42:26 -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 chore: Update repo readme (#927) 2022-11-04 15:50:26 -05:00
package-lock.json Switched hero image to webp 2022-11-05 20:42:26 -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.