c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-29 15:11:58 +00:00
Code Releases Activity
immich/docs
History
bo0tzz 5c63d8f07a
format(docs) (#4064) 
* fix(docs): Link typo

* fix(docs): Footnote whitespace

* format(docs)
2023-09-12 15:30:15 +07:00
..
blog blog: july 2023 (#3466) 2023-07-29 21:30:30 -05:00
docs format(docs) (#4064) 2023-09-12 15:30:15 +07:00
src docs: add mobile links (#3214) 2023-07-11 10:10:28 -05:00
static docs: add mobile links (#3214) 2023-07-11 10:10:28 -05:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06: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(blog): Make blog public, add June 2023 update post (#2935) 2023-06-24 22:02:39 -05:00
package-lock.json docs: upgrade deps (#3215) 2023-07-11 10:09:19 -05:00
package.json docs: upgrade deps (#3215) 2023-07-11 10:09:19 -05:00
README.md Change documentation folder to docs 2022-10-27 21:44:37 -05:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tsconfig.json Change documentation folder to docs 2022-10-27 21:44:37 -05:00
vercel.json docs: update contributing pages (#2503) 2023-05-20 20:46:09 -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.