extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-21 23:53:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

more website rearranging

Browse Source
This commit is contained in:
dovholuknf 2023-01-27 11:42:58 -05:00
parent aec01ad1f3
commit 0c8650c804
No known key found for this signature in database
GPG Key ID: 0EE08251136D3480
6 changed files with 1289 additions and 8908 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
BUILD.md
View File

@ -1,8 +1,27 @@
# Build
At this time, building `zrok` is pretty straight-forward. To build, follow these steps:
## zrok
At this time, building `zrok` is pretty straight-forward. You will require `npm` to be installed in order to complete
the build as well as `go`.
To build, follow these steps:
* clone the repository
* change to the existing `build` folder
* run `npm install`
* run `npm run build`
* run `npm run build` (this process takes a while the first time and only needs to be run if the ui changes)
* change back to the checkout root
* build the go project normally: `go build -o dist ./...`
## Documentation/Website
The doc website is based on [Docusaurus](https://docusaurus.io/) which in turn will require `npm` to be installed. `yarn`
is another tool which is used to start the Docusaurus dev site.
To build the doc:
* cd to `website`
* run `yarn install` (usually only needed once)
* run `yarn start` to start the development server (make sure port 3000 is open or change the port)
The development server infrequently behaves differently than the 'production' build. If you must use the 'production'
build it is slower, but you can accomplish that with `yarn build`.

11
docusaurus.config.js → website/docusaurus.config.js
View File

@ -7,7 +7,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Zrok',
staticDirectories: ['website/static', 'docs/images'],
staticDirectories: ['static', '../docs/images'],
tagline: 'Globally distributed reverse proxy',
url: 'https://zrok.io',
baseUrl: '/',
@ -37,16 +37,17 @@ const config = {
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./website/sidebars.js'),
sidebarPath: require.resolve('./sidebars.js'),
editUrl:
'https://github.com/openziti/zrok/tree/main/',
path: './docs',
path: '../docs',
include: ['**/*.md', '**/*.mdx', '**/*.svg', '**/*.png'],
},
theme: {
customCss: require.resolve('./website/src/css/custom.css'),
customCss: require.resolve('./src/css/custom.css'),
},
pages: {
path: './website/src/pages'
path: './src/pages'
},
// googleAnalytics: {
//

2
package.json → website/package.json
View File

@ -5,7 +5,7 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "BUILD_PATH='./build/docs docusaurus build",
"build": "BUILD_PATH='./build/docs' docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",

2
website/src/pages/index.js
View File

@ -32,7 +32,7 @@ export default function Home() {
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
<main className={styles.rowcontainer}>
<iframe className={styles.secondrow} src="https://zrok.io"></iframe>
<iframe className={styles.secondrow} src="https://zrokiostg.wpengine.com/"></iframe>
</main>
</Layout>
);

2272
website/yarn.lock
View File

File diff suppressed because it is too large Load Diff

7887
yarn.lock
View File

File diff suppressed because it is too large Load Diff