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

History

Jason Rasmussen 67c52c3764 chore(docs): contributing (#1311 ) * chore(server): linting * chore: contributing pr checklist		2023-01-12 08:44:11 -06:00
..
blog	Added v1.36 release note to website	2022-11-21 12:53:25 -06:00
docs	chore(docs): contributing (#1311 )	2023-01-12 08:44:11 -06:00
src	Update font size of landing page on mobile	2022-12-22 11:12:37 -06:00
static	Update documentation	2022-11-08 14:22:42 -06:00
.gitignore	Small docs site tweaks (#954 )	2022-11-10 08:20:23 -06:00
babel.config.js	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
docusaurus.config.js	Update docs and readme	2022-12-27 14:28:25 -06:00
package-lock.json	chore(docs) revamp landing page (#1161 )	2022-12-22 10:31:31 -06:00
package.json	chore(docs) revamp landing page (#1161 )	2022-12-22 10:31:31 -06:00
README.md	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
sidebars.js	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
tailwind.config.js	chore(docs) revamp landing page (#1161 )	2022-12-22 10:31:31 -06:00
tsconfig.json	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
vercel.json	chore(docs): refactor pages (#1144 )	2022-12-21 15:01:50 -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.