immich/docs
Matthew Momjian dc4f7bef69
Specify PowerShell for win backup/restore (#9262)
Update backup-and-restore.md
2024-05-04 16:23:53 -04:00
..
blog feat: dream comes true 2024-05-02 01:33:17 +01:00
docs Specify PowerShell for win backup/restore (#9262) 2024-05-04 16:23:53 -04:00
src chore: Remove sponsor link from homepage (#9226) 2024-05-02 11:42:54 -05:00
static docs: community projects (#8641) 2024-04-09 07:03:25 +02:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc chore: fvm and node dependency updates and pinning (#9203) 2024-05-01 14:05:18 +01: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: link to blog in announcement (#9208) 2024-05-02 01:33:17 +01:00
package-lock.json chore: upgrade docusaurus-preset-openapi to remove axios (#9167) 2024-04-29 22:19:18 -04:00
package.json chore: fvm and node dependency updates and pinning (#9203) 2024-05-01 14:05:18 +01:00
README.md Docs: minor changes (#8814) 2024-04-16 07:26:12 +02:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js chore: Remove sponsor link from homepage (#9226) 2024-05-02 11:42:54 -05:00
tsconfig.json fix(deps): update docs (#7068) 2024-02-13 14:07:16 +00:00

Website

This website is built using Docusaurus, 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.