1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-04-23 00:06:37 +02:00
immich/docs
Nicholas Flamy edbcf17e3a
fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation ()
fix tsx IDE (VSCode) issues in docs by migrating tsconfig extends from the Docusaurus tsconfig 2.X package to the 3.X package
2025-02-24 13:24:28 -06:00
..
blog chore(docs): change some wording () 2024-07-18 16:52:45 -04:00
docs docs: clarify custom locations guide () 2025-02-20 22:31:29 -06:00
src fix: merch link () 2025-02-10 16:56:40 +00:00
static chore(docs): Synology set-up guide () 2025-02-18 13:39:42 -06:00
.gitignore Small docs site tweaks () 2022-11-10 08:20:23 -06:00
.nvmrc chore(deps): update node.js to v22.14.0 () 2025-02-15 21:29:33 -06:00
.prettierignore ci: doc format check () 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check () 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: merch links () 2025-02-02 00:26:23 +01:00
package-lock.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation () 2025-02-24 13:24:28 -06:00
package.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation () 2025-02-24 13:24:28 -06:00
README.md docs: use npm in README () 2024-05-17 16:49:23 -04:00
sidebars.js ci: doc format check () 2023-04-24 12:49:20 -05:00
tailwind.config.js feat(doc): new homepage design and font () 2024-10-03 13:33:36 +07:00
tsconfig.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation () 2025-02-24 13:24:28 -06: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.