cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-15 09:59:00 -07:00
Code Issues Packages Projects Releases Wiki Activity
d0cc231782
immich/docs
History
wittymap c92c442356
Update restore example to address SQL errors on database import. (#2663)
2023-06-05 08:56:39 -05:00
..
blog ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
docs Update restore example to address SQL errors on database import. (#2663) 2023-06-05 08:56:39 -05:00
src chore: update screenshots for readme and docs (#2425) 2023-05-10 23:33:32 -05:00
static chore: update screenshots for readme and docs (#2425) 2023-05-10 23:33:32 -05:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.prettierignore ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js docs: remove roadmap link (#2442) 2023-05-15 18:25:46 +00:00
package-lock.json ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
package.json ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
README.md Change documentation folder to docs 2022-10-27 21:44:37 -05:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tsconfig.json Change documentation folder to docs 2022-10-27 21:44:37 -05:00
vercel.json docs: update contributing pages (#2503) 2023-05-20 20:46:09 -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.