immich/docs
Aaron Rodrigues d61828598b
fix(docs): spelling (#11859)
* Update requirements.md

* Update unraid.md

* Update shared-albums.md

* Update shared-albums.md

* Update unraid.md

* Update shared-albums.md
2024-08-16 23:14:53 -04:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs fix(docs): spelling (#11859) 2024-08-16 23:14:53 -04:00
src chore: more cursed knowledge (#11631) 2024-08-07 09:54:57 -04:00
static Version v1.112.1 2024-08-15 00:00:22 +00:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc chore(deps): update dependency node to v20.16.0 (#11421) 2024-07-29 10:33:01 -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 chore: more cursed knowledge (#11631) 2024-08-07 09:54:57 -04:00
package-lock.json chore(deps): update dependency tailwindcss to v3.4.9 (#11750) 2024-08-13 11:37:06 -04:00
package.json chore(deps): update dependency node to v20.16.0 (#11421) 2024-07-29 10:33:01 -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 chore: remove unused snowburst one font (#10863) 2024-07-04 17:15:54 -04:00
tsconfig.json fix(deps): update docs (#7068) 2024-02-13 14:07:16 +00:00

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.