1
0
mirror of https://github.com/immich-app/immich.git synced 2025-02-03 18:33:20 +02:00
Richard Salame 827ec1b63a
chore(doc): update quick-start.mdx (#10276)
Update quick-start.mdx

The following changes are made:

- Changed the headings to capital case.
- Changed a few sentences to sound more clear.
- Removed '?' from the heading as per the standards.
2024-06-13 09:23:02 -05:00
..
2024-05-02 01:33:17 +01:00
2024-06-11 10:33:45 +01:00
2024-06-12 18:26:10 +00:00
2022-11-10 08:20:23 -06:00
2023-04-24 12:49:20 -05:00
2023-04-24 12:49:20 -05:00
2024-05-17 16:49:23 -04:00
2023-04-24 12:49:20 -05:00
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.