mirror of https://github.com/immich-app/immich.git synced 2024-11-15 18:08:48 -07:00

History

renovate[bot] 9300946ff1 fix(deps): update docs (#6420 ) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>		2024-01-16 09:27:04 -05:00
..
blog	docs: recap 2023 (#5665 )	2023-12-13 03:03:15 +00:00
docs	docs: fix pgadmin links (#6403 )	2024-01-15 17:19:41 +00:00
src	fix(web): use env for web folder path (#5753 )	2023-12-16 11:15:30 -06:00
static	docs: fix redirects for cloudflare (#5734 )	2023-12-15 15:20:50 -06: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	refactor: open api (#6334 )	2024-01-12 07:36:27 -05:00
package-lock.json	fix(deps): update docs (#6420 )	2024-01-16 09:27:04 -05:00
package.json	docs: clean-up old references (#5697 )	2023-12-14 09:53:08 -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	docs: add sponsor link (#5597 )	2023-12-09 20:59:00 -06:00
tsconfig.json	chore(server,web,docs) bulk bump of dependencies with vulnerabilities (#4312 )	2023-10-10 08:31:21 -04:00

Website

This website is built using Docusaurus 2, a modern static website generator.

$ yarn

$ 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.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

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.