self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-30 09:47:31 +02:00
Code Issues Releases Activity
9fe80c25eb
immich/docs
History
renovate[bot] 1ad893ded4
fix(deps): update typescript-projects (#8281) 
* fix(deps): update typescript-projects

* chore: regenerate sql

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-03-26 02:39:57 +00:00
..
blog feat(docs): New repair and statistics pages (#8030) 2024-03-23 19:43:10 +00:00
docs chore(docs): Update docker compose readme with wget download option (#8250) 2024-03-25 05:01:29 +00:00
src fix(doc): logo size on small screen (#7992) 2024-03-15 15:59:25 -05:00
static feat(docs): Changes to the Administration section. (#8078) 2024-03-24 02:04:32 +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 feat(doc): new logo and screenshots (#7961) 2024-03-14 22:15:20 -05:00
package-lock.json fix(deps): update typescript-projects (#8281) 2024-03-26 02:39:57 +00: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(deps): update docs (#7068) 2024-02-13 14:07:16 +00:00

README.md

Website

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

Installation

$ yarn

Local Development

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

Build

$ yarn build

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

Deployment

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.