https://github.com/brimdata/zui-docs-site
https://github.com/brimdata/zui-docs-site
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brimdata/zui-docs-site
- Owner: brimdata
- Created: 2022-09-08T18:51:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T18:37:32.000Z (over 1 year ago)
- Last Synced: 2024-09-10T20:58:28.479Z (over 1 year ago)
- Language: CSS
- Size: 2.73 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The Zui Docs Website
This repository contains [Docusaurus 2](https://docusaurus.io/)
source and configuration files for generating the static website
for the public documentation of the open-source Zui project.
All content for the documentation is stored in markdown files
in the [`docs` directory](https://github.com/brimdata/zui/tree/main/docs)
of the
[Zui repository](https://github.com/brimdata/zui).
### Setup
To setup the Docusaurus environment, clone this repo, cd into it, and run:
```
$ yarn
```
### Local Development
To edit or author new documentation, it's easiest to clone the Zui repository
into the same top-level directory as this repo and simply run `make dev`
in this repo. This will create a symlink from called `docs` in
this directory that points to `../zui/docs`, launches the local docusaurus
server, and directs your browser to this server.
You can ctrl-C the `make dev` process to stop the server.
Any edits you make to files in ../zui/docs will be immediatedly re-rendered
by the docusaurus server.
### Rendering from Zui repo
If you don't have a clone of the Zui repo in `..`, you can pull the
Zui repo docs directory into the ./docs subdirectory by running:
```bash
make fetch-latest
```
Then you can run the docusaurus server with:
```
$ 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.