{"id":28633853,"url":"https://github.com/brimdata/zui-docs-site","last_synced_at":"2025-06-12T15:39:32.914Z","repository":{"id":68668622,"uuid":"534351808","full_name":"brimdata/zui-docs-site","owner":"brimdata","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-10T18:37:32.000Z","size":2866,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-09-10T20:58:28.479Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brimdata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-08T18:51:54.000Z","updated_at":"2024-09-10T18:37:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"9c76e346-6d14-4e7a-b721-e99ad9174cff","html_url":"https://github.com/brimdata/zui-docs-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/brimdata/zui-docs-site","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brimdata%2Fzui-docs-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brimdata%2Fzui-docs-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brimdata%2Fzui-docs-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brimdata%2Fzui-docs-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brimdata","download_url":"https://codeload.github.com/brimdata/zui-docs-site/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brimdata%2Fzui-docs-site/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259495284,"owners_count":22866657,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-12T15:39:19.904Z","updated_at":"2025-06-12T15:39:32.902Z","avatar_url":"https://github.com/brimdata.png","language":"CSS","readme":"# The Zui Docs Website\n\nThis repository contains [Docusaurus 2](https://docusaurus.io/)\nsource and configuration files for generating the static website\nfor the public documentation of the open-source Zui project.\n\nAll content for the documentation is stored in markdown files\nin the [`docs` directory](https://github.com/brimdata/zui/tree/main/docs)\nof the\n[Zui repository](https://github.com/brimdata/zui).\n\n### Setup\n\nTo setup the Docusaurus environment, clone this repo, cd into it, and run:\n```\n$ yarn\n```\n\n### Local Development\n\nTo edit or author new documentation, it's easiest to clone the Zui repository\ninto the same top-level directory as this repo and simply run `make dev`\nin this repo.  This will create a symlink from called `docs` in\nthis directory that points to `../zui/docs`, launches the local docusaurus\nserver, and directs your browser to this server.\n\nYou can ctrl-C the `make dev` process to stop the server.\n\nAny edits you make to files in ../zui/docs will be immediatedly re-rendered\nby the docusaurus server.\n\n### Rendering from Zui repo\n\nIf you don't have a clone of the Zui repo in `..`, you can pull the\nZui repo docs directory into the ./docs subdirectory by running:\n```bash\nmake fetch-latest\n```\nThen you can run the docusaurus server with:\n```\n$ yarn start\n```\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrimdata%2Fzui-docs-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrimdata%2Fzui-docs-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrimdata%2Fzui-docs-site/lists"}