self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-22 01:47:08 +02:00
Code Issues Releases Activity
ca28e1e7a8
immich/docs
History
aviv926 19d4c5e9f7
docs: Update documentation (#6430) 
* Documentation corrections

* fix import

* add firewall note

* npm run format:fix

* fixs

* npm run format:fix

* space

* fix note

* admin-jobs.png image update + fixes

* Storage Template.md update

* Add new Troubleshooting about symbolic link in library

* Updating the libraries.md

* Updating the libraries.md

* Corrections

* add `/`

* ...

* Add Python script to remove-offline-files.md

* npm run format:fix

* Add info about HDR in FAQ

* My wrong merge

* add info about symlink

* [Community] + PowerShell

* add 360 photo support to Features in README

* add info about remote ML and info about orphaned files from the external library to the scripts page

* Typo

* add note about storage locations

* add info about Purge for portainer and link to info about asset types and storage locations

* npm run format:fix

* Add FAQ about "faces" that aren't faces

* Update docs/docs/administration/backup-and-restore.md

* Update docs/docs/administration/backup-and-restore.md

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-25 17:17:38 +00:00
..
blog chore: recap post date 2024-01-19 19:44:01 -06:00
docs docs: Update documentation (#6430) 2024-01-25 17:17:38 +00:00
src fix(docs): search (#6605) 2024-01-23 17:50:25 -05:00
static chore: remove unused files and references (#6562) 2024-01-21 22:57:37 -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: diff highlighting (#6604) 2024-01-23 18:51:02 +00:00
package-lock.json deps: update docs (#6462) 2024-01-17 22:44:45 -05: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 deps: update docs (#6462) 2024-01-17 22:44:45 -05: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.