1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-25 10:43:13 +02:00
immich/docs
Jonathan Jogenfors 7e38e7c949
feat(cli): refactor and add album support (#4434)
* Allow building and installing cli

* feat: add format fix

* docs: remove cli folder

* feat: use immich scoped package

* feat: rewrite cli readme

* docs: add info on running without building

* cleanup

* chore: remove import functionality from cli

* feat: add logout to cli

* docs: add todo for file format from server

* docs: add compilation step to cli

* fix: success message spacing

* feat: can create albums

* fix: add check step to cli

* fix: typos

* feat: pull file formats from server

* chore: use crawl service from server

* chore: fix lint

* docs: add cli documentation

* chore: rename ignore pattern

* chore: add version number to cli

* feat: use sdk

* fix: cleanup

* feat: album name on windows

* chore: remove skipped asset field

* feat: add more info to server-info command

* chore: cleanup

* chore: remove unneeded packages

* chore: fix docs links

* feat: add cli v2 milestone

* fix: set correct cli date

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2023-11-19 22:16:24 +00:00
..
blog docs: remove read-only related content (#4781) 2023-11-01 20:49:57 -05:00
docs feat(cli): refactor and add album support (#4434) 2023-11-19 22:16:24 +00:00
src feat(cli): refactor and add album support (#4434) 2023-11-19 22:16:24 +00:00
static docs: update (#4893) 2023-11-07 15:52:44 -06: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: milestones (#4593) 2023-10-22 21:34:23 -05:00
package-lock.json fix(deps): update dependency tailwindcss to v3.3.5 (#4980) 2023-11-12 10:04:24 -05:00
package.json docs: milestones (#4593) 2023-10-22 21:34:23 -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.

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.