c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-04 02:46:47 +01:00
Code Releases Activity
immich/documentation
History
Alex 7d118b5d42
feat(app) add documentation site template (#879) 
* Added site

* update

* Added overview section

* Added skeleton
2022-10-27 21:38:26 -05:00
..
blog feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
docs feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
src feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
static feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
.gitignore feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
babel.config.js feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
docusaurus.config.js feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
package-lock.json feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
package.json feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
README.md feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
sidebars.js feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00
tsconfig.json feat(app) add documentation site template (#879) 2022-10-27 21:38:26 -05:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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

$ yarn 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.