mirror of https://github.com/openziti/zrok.git synced 2024-12-23 15:18:52 +01:00

History

Kenneth Bingham bfb32ffdb6 stop overriding the Vercel ignore command because gh-pages branch never contains the vercel.json file		2023-02-01 12:14:30 -05:00
..
blog	introducing zrok; paragraph	2023-01-27 13:54:34 -05:00
src	remove leftover debug coloring	2023-01-30 15:37:59 -05:00
static	add CNAME	2023-01-30 13:58:02 -05:00
.gitignore	add package-lock and unignore	2023-01-27 22:12:49 -05:00
babel.config.js	initial attempt at website	2023-01-25 16:04:35 -05:00
docusaurus.config.js	updates to doc	2023-01-30 14:19:39 -05:00
package-lock.json	add package-lock and unignore	2023-01-27 22:12:49 -05:00
package.json	more website rearranging	2023-01-27 11:42:58 -05:00
README.md	initial attempt at website	2023-01-25 16:04:35 -05:00
sidebars.js	initial attempt at website	2023-01-25 16:04:35 -05:00
vercel.json	stop overriding the Vercel ignore command because gh-pages branch never contains the vercel.json file	2023-02-01 12:14:30 -05:00
yarn.lock	updates to get npm run build to succeed	2023-01-27 22:22:08 -05: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.