History

Daniel Dietzler 6000c7f3bc update docs to use docker compose (#5446 )		2023-12-02 12:48:49 +01:00
..
blog	docs: remove read-only related content (#4781 )	2023-11-01 20:49:57 -05:00
docs	update docs to use docker compose (#5446 )	2023-12-02 12:48:49 +01:00
src	chore(deps): update dependency prettier to v3 (#5371 )	2023-11-29 02:30:53 +00:00
static	docs: update (#4893 )	2023-11-07 15:52:44 -06: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
README.md	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
babel.config.js	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
docusaurus.config.js	docs: milestones (#4593 )	2023-10-22 21:34:23 -05:00
package-lock.json	fix(deps): update dependency clsx to v2 (#5383 )	2023-11-29 04:07:05 +00:00
package.json	fix(deps): update dependency clsx to v2 (#5383 )	2023-11-29 04:07:05 +00: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	chore(server,web,docs) bulk bump of dependencies with vulnerabilities (#4312 )	2023-10-10 08:31:21 -04:00
vercel.json	chore(docs): Redirect old CLI paths (#5183 )	2023-11-20 13:20:58 +00:00

Website

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

$ yarn

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

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

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.