jcianci12 27be076958
docs: add step by step set up guide for external libraries (#5288)
* Update libraries.md - External Library step by step set up guide added

When setting up immmich external libraries, I found some missing details around the relationship between external paths and import paths. By providing an example, I am hoping it helps new users.

* chore: fix formatting

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-01 22:18:28 -05:00
..
2023-12-13 03:03:15 +00:00
2022-11-10 08:20:23 -06:00
2023-04-24 12:49:20 -05:00
2023-04-24 12:49:20 -05:00
2022-10-27 21:44:37 -05:00
2023-04-24 12:49:20 -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.