1
0
mirror of https://github.com/immich-app/immich.git synced 2024-11-24 08:52:28 +02:00
immich/docs
Jason Rasmussen 9bb6befc92
docs: clean-up old references (#5697)
* docs: clean-up old references

* chore: fix ref
2023-12-14 09:53:08 -05:00
..
blog docs: recap 2023 (#5665) 2023-12-13 03:03:15 +00:00
docs docs: clean-up old references (#5697) 2023-12-14 09:53:08 -05:00
src docs: add sponsor link (#5597) 2023-12-09 20:59:00 -06:00
static docs: update (#4893) 2023-11-07 15:52:44 -06:00
_redirects chore: add _redirects to docs for CloudFlare 2023-12-11 16:13:39 -06:00
.gitignore
.prettierignore
.prettierrc
babel.config.js
docusaurus.config.js docs: milestones (#4593) 2023-10-22 21:34:23 -05:00
package-lock.json docs: clean-up old references (#5697) 2023-12-14 09:53:08 -05:00
package.json docs: clean-up old references (#5697) 2023-12-14 09:53:08 -05:00
README.md
sidebars.js
tailwind.config.js docs: add sponsor link (#5597) 2023-12-09 20:59:00 -06:00
tsconfig.json chore(server,web,docs) bulk bump of dependencies with vulnerabilities (#4312) 2023-10-10 08:31:21 -04:00
vercel.json chore(docs): Redirect old CLI paths (#5183) 2023-11-20 13:20:58 +00:00

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.