Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2025-05-24 01:12:58 -04:00
Code Issues Packages Projects Releases Wiki Activity
immich/docs
History
Matthew Momjian be1187bc46
chore(docs): clarify experimental network features (#15228) 
* auth

* URL switch

* mobile app

* caps

* headers, app changes

* oxford comma

* Match case to other use in Immich

* add url

* asset download also causes issues
2025-01-11 22:09:54 -06:00
..
blog
chore(docs): change some wording (#11201)
2024-07-18 16:52:45 -04:00
docs
chore(docs): clarify experimental network features (#15228)
2025-01-11 22:09:54 -06:00
src
chore(docs): clean up and add new content (#15003)
2025-01-02 10:04:14 -06:00
static
chore: version v1.124.2
2025-01-08 23:16:35 +00:00
.gitignore
Small docs site tweaks (#954)
2022-11-10 08:20:23 -06:00
.nvmrc
chore(deps): update node.js to v22.13.0 (#15249)
2025-01-11 22:04:22 -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 homepage design and font (#13084)
2024-10-03 13:33:36 +07:00
package-lock.json
chore(docs): clean up and add new content (#15003)
2025-01-02 10:04:14 -06:00
package.json
chore(deps): update node.js to v22.13.0 (#15249)
2025-01-11 22:04:22 -06:00
README.md
docs: use npm in README (#9566)
2024-05-17 16:49:23 -04:00
sidebars.js
ci: doc format check (#2325)
2023-04-24 12:49:20 -05:00
tailwind.config.js
feat(doc): new homepage design and font (#13084)
2024-10-03 13:33:36 +07: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, a modern static website generator.

Installation

$ npm install

Local Development

$ npm run 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

$ npm run 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 npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run 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.