cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-16 02:18:50 -07:00
Code Issues Packages Projects Releases Wiki Activity
81f0265095
immich/docs
History
Mert c4e910dd3d
docs(server): add documentation for prometheus metrics (#8084) 
* add monitoring doc

* wording

* indent

* note instead of tip

* Update docs/docs/features/monitoring.md

Co-authored-by: bo0tzz <git@bo0tzz.me>

* Update docs/docs/features/monitoring.md

Co-authored-by: bo0tzz <git@bo0tzz.me>

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
Co-authored-by: bo0tzz <git@bo0tzz.me>
2024-03-20 09:20:46 -05:00
..
blog chore: update btc address 2024-02-12 14:29:29 -06:00
docs docs(server): add documentation for prometheus metrics (#8084) 2024-03-20 09:20:46 -05:00
src fix(doc): logo size on small screen (#7992) 2024-03-15 15:59:25 -05:00
static feat(doc): new logo and screenshots (#7961) 2024-03-14 22:15:20 -05: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 feat(doc): new logo and screenshots (#7961) 2024-03-14 22:15:20 -05:00
package-lock.json fix(deps): update docs (#7870) 2024-03-11 23:21:29 -04: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.