mirror of https://github.com/immich-app/immich.git synced 2024-09-22 02:57:26 +00:00

History

Jason Rasmussen bddeb03fd5 docs: immich title (#4463 )		2023-10-13 09:15:29 -05:00
..
blog	blog: july 2023 (#3466 )	2023-07-29 21:30:30 -05:00
docs	feat(server): harden move file (#4361 )	2023-10-10 21:14:44 -05:00
src	docs: immich title (#4463 )	2023-10-13 09:15:29 -05:00
static	docs: add mobile links (#3214 )	2023-07-11 10:10:28 -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: immich title (#4463 )	2023-10-13 09:15:29 -05:00
package-lock.json	fix(docs): production build (#4431 )	2023-10-10 21:49:24 -05:00
package.json	fix(docs): production build (#4431 )	2023-10-10 21:49:24 -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	chore(server,web,docs) bulk bump of dependencies with vulnerabilities (#4312 )	2023-10-10 08:31:21 -04: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.