cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-15 09:59:00 -07:00
Code Issues Packages Projects Releases Wiki Activity
feat/ml-flores
immich/docs
History
mertalev 8ea15a99c8
add docs 
formatting

clean up docs

wording
2024-10-17 20:40:35 -04:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs add docs 2024-10-17 20:40:35 -04:00
src feat(docs): update roadmap (#13212) 2024-10-05 19:00:09 -04:00
static chore: version v1.118.2 2024-10-16 18:44:39 +00:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc chore(deps): update dependency node to v20.18.0 (#13271) 2024-10-07 22:42:33 -04: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(deps): update typescript-projects (#13453) 2024-10-16 04:57:57 -04:00
package.json chore(deps): update dependency node to v20.18.0 (#13271) 2024-10-07 22:42:33 -04: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.