1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-26 10:50:29 +02:00
immich/docs
Mauro Molin 9076f3e69e
Fix bulk upload example commands to work with paths with spaces (#2159)
The examples commands didn't work when the result of the subcommand $(pwd) contained spaces. This commit adds the proper escaping for them to work. This change also fixes the behavior of the alias allowing the correct current directory to be passed when it is placed inside the .bashrc file.
2023-04-03 20:19:10 -05:00
..
blog Added v1.36 release note to website 2022-11-21 12:53:25 -06:00
docs Fix bulk upload example commands to work with paths with spaces (#2159) 2023-04-03 20:19:10 -05:00
src chores(doc): Update documentation (#2145) 2023-04-01 21:22:16 -05:00
static Update documentation 2022-11-08 14:22:42 -06:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js chores(doc): Update documentation (#2145) 2023-04-01 21:22:16 -05:00
package-lock.json chores(doc): Update documentation (#2145) 2023-04-01 21:22:16 -05:00
package.json chores(doc): Update documentation (#2145) 2023-04-01 21:22:16 -05:00
README.md Change documentation folder to docs 2022-10-27 21:44:37 -05:00
sidebars.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
tailwind.config.js chore(docs) revamp landing page (#1161) 2022-12-22 10:31:31 -06:00
tsconfig.json Change documentation folder to docs 2022-10-27 21:44:37 -05:00
vercel.json docs: Split features into new administration category (#1440) 2023-01-27 08:32:52 -06:00

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.