extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-12-22 23:02:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
4b012d94ae
zrok/website
History
Kenneth Bingham 4b012d94ae
add getting started cards for hosted and self-hosted
2024-08-30 17:06:35 -04:00
..
src add getting started cards for hosted and self-hosted 2024-08-30 17:06:35 -04:00
static add pricing and account to top nav 2024-08-30 15:55:21 -04: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 add pricing and account to top nav 2024-08-30 15:55:21 -04:00
package-lock.json add getting started cards for hosted and self-hosted 2024-08-30 17:06:35 -04:00
package.json add getting started cards for hosted and self-hosted 2024-08-30 17:06:35 -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

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.