mirror of https://github.com/immich-app/immich.git synced 2024-11-24 08:52:28 +02:00

History

Alex Tran 294955db17 wording		2023-06-23 23:32:39 -05:00
..
blog	ci: doc format check (#2325 )	2023-04-24 12:49:20 -05:00
docs	wording	2023-06-23 23:32: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	fix(deps): update dependency tailwindcss to v3.3.2 (#2808 )	2023-06-16 17:14:29 +00:00
package.json	chore(deps): update dependency typescript to v5 (#2795 )	2023-06-16 10:43:40 -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

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.