cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-15 01:48:49 -07:00
Code Issues Packages Projects Releases Wiki Activity
main
immich/docs
History
mcarbonne 5a2af558fb
feat: add minimal devcontainer setup (#14038) 
* add minimal devcontainer setup

* fix Makefile & update doc

* fix Makefile

* add warning regarding devcontainer + add newline at EOF
2024-11-13 11:28:07 -06:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs feat: add minimal devcontainer setup (#14038) 2024-11-13 11:28:07 -06:00
src chore(docs): roadmap SEO (#14024) 2024-11-08 19:48:23 -05:00
static chore: version v1.120.2 2024-11-12 17:30:29 +00:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc chore(deps): update dependency node to v22 (#13855) 2024-10-31 14:21:45 +00: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 (#13789) 2024-10-30 15:03:32 -04:00
package.json chore(deps): update dependency node to v22 (#13855) 2024-10-31 14:21:45 +00: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.