cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-15 18:08:48 -07:00
Code Issues Packages Projects Releases Wiki Activity
9bf1d87e35
immich/docs
History
Nicholas Flamy 70881bc97f
Update truenas.md with permission info. (#7606) 
* Update truenas.md with permission info.

This is very important information about permissions on datasets used by immich.

* Update truenas.md

* Update truenas.md with proper formatting
2024-03-05 02:51:20 +00:00
..
blog chore: update btc address 2024-02-12 14:29:29 -06:00
docs Update truenas.md with permission info. (#7606) 2024-03-05 02:51:20 +00:00
src chore: add agpl milestone (#7479) 2024-02-27 21:43:12 +00:00
static docs: fix broken link (#6735) 2024-01-29 22:09:33 +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 Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00:00
package-lock.json fix(deps): update dependency @mdx-js/react to v3.0.1 (#7222) 2024-02-19 22:34:01 -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 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.