mirror of https://github.com/immich-app/immich.git synced 2024-11-25 09:01:22 +02:00

History

Lukas 2010c92b61 docs: fix web development setup instructions (#6969 )		2024-02-08 02:59:39 +00:00
..
blog	chore: recap post date	2024-01-19 19:44:01 -06:00
docs	docs: fix web development setup instructions (#6969 )	2024-02-08 02:59:39 +00:00
src	docs: update milestones (#6787 )	2024-01-31 07:01:53 -05:00
static	docs: fix broken link (#6735 )	2024-01-29 22:09:33 +00: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: diff highlighting (#6604 )	2024-01-23 18:51:02 +00:00
package-lock.json	fix(deps) CVE–2023–45857 (bump axios) (#6665 )	2024-01-26 19:26:31 -05:00
package.json	deps: update docs (#6462 )	2024-01-17 22:44:45 -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	fix(docs): formatting	2024-01-30 13:45:18 -06: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.