mirror of https://github.com/openziti/zrok.git synced 2024-11-22 08:03:49 +01:00

History

Michael Quigley eda30080bb Merge pull request #673 from openziti/snyk-upgrade-5457de1c991077906eaea19132c10ba9 [Snyk] Upgrade @mdx-js/react from 3.0.0 to 3.0.1 (website)		2024-06-24 12:47:08 -04:00
..
src	select tab 'Docker' unless OS is Linux	2024-05-21 12:06:30 -04:00
static	chore: normalize encoding for the text files	2024-02-12 21:00:52 +01:00
.gitignore	add package-lock and unignore	2023-01-27 22:12:49 -05:00
.nvmrc	organize download and install info as guides and add nice downloads	2023-11-22 23:00:48 -05:00
algolia-crawler-config.js	add a crawler schedule	2024-01-12 00:11:41 -05:00
babel.config.js	initial attempt at website	2023-01-25 16:04:35 -05:00
docusaurus.config.js	organize nginx guide in linux category	2024-05-03 10:48:17 -04:00
package-lock.json	Merge pull request #673 from openziti/snyk-upgrade-5457de1c991077906eaea19132c10ba9	2024-06-24 12:47:08 -04:00
package.json	Merge pull request #673 from openziti/snyk-upgrade-5457de1c991077906eaea19132c10ba9	2024-06-24 12:47:08 -04: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	build docs when any markdown changes so we can import them in docusaurus	2024-04-26 14:42:23 -04: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.