{"id":20834962,"url":"https://github.com/hstreamdb/docs-next","last_synced_at":"2025-05-08T02:23:36.712Z","repository":{"id":156006768,"uuid":"627848998","full_name":"hstreamdb/docs-next","owner":"hstreamdb","description":"The next generation of documentation for HStreamDB.","archived":false,"fork":false,"pushed_at":"2024-05-29T09:12:36.000Z","size":2745,"stargazers_count":1,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-15T00:51:13.095Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.hstream.io","language":"Python","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/hstreamdb.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":"docs/security/_index.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-14T10:35:36.000Z","updated_at":"2024-04-26T07:13:20.000Z","dependencies_parsed_at":"2024-01-16T04:14:29.884Z","dependency_job_id":"70a4d545-7db3-4beb-9f70-af36bd9ffb24","html_url":"https://github.com/hstreamdb/docs-next","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hstreamdb%2Fdocs-next","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hstreamdb%2Fdocs-next/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hstreamdb%2Fdocs-next/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hstreamdb%2Fdocs-next/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hstreamdb","download_url":"https://codeload.github.com/hstreamdb/docs-next/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252985077,"owners_count":21835917,"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":"2024-11-18T00:22:08.946Z","updated_at":"2025-05-08T02:23:36.680Z","avatar_url":"https://github.com/hstreamdb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docs-next\n\nThe next generation of documentation for HStreamDB.\n\n## Table of Contents\n\n- [Development](#development)\n  - [Normal markdown files](#normal-markdown-files)\n  - [`index.md`](#indexmd)\n  - [\\_index.md](#_indexmd)\n  - [About sidebar](#about-sidebar)\n  - [Special markdown syntaxes](#special-markdown-syntaxes)\n- [Release a new version](#release-a-new-version)\n\n## Development\n\nWe use [pnpm](https://pnpm.io/) as our package manager. Run following commands to install dependencies and start the development server in your local environment.\n\n```bash\npnpm install\npnpm run dev\n```\n\nThe rest of the time after that you will most likely be editing the following files:\n\n- [Normal markdown files](#normal-markdown-files)\n- [`index.md`](#indexmd)\n- [`_index.md`](#_indexmd)\n\nWe'll talk about what these files do later.\n\n### Normal markdown files\n\nNormal markdown files are just markdown files that are not `index.md` or `_index.md`. They are rendered as a single doc page based on the file structure of the `docs` folder.\n\n### index.md\n\n`index.md` is a special file that is used to represent a separate directory page. This means that when you click on the group in the sidebar, it won't expand or collapse the group by default, but will display the contents of `index.md` instead.\n\n### \\_index.md\n\n`_index.md` is a special file that is used to generate the [sidebar](#about-sidebar). It contains the metadata of the group and **must exist**.\n\nCurrently, it supports the following metadata:\n\n```markdown\n---\ntitle: \u003ctitle\u003e\norder: \u003corder\u003e\ncollapsed: \u003ccollapsed:true|false\u003e\n---\n\n\u003ctitle\u003e\n```\n\n- `\u003ctitle\u003e` is the name of the group. If it is not present, the group name will be rendered as the folder name.\n\n  \u003e The priority of `\u003ctitle\u003e` in the front matter is higher than the `\u003ctitle\u003e` in the content (all of the content will also be treated as the group name).\n\n  For example, if you write `title: User Guides` or the content of `docs/guides/_index.md` is `User Guides`, so the group `guides` will be rendered as `User Guides` in the sidebar.\n\n- `\u003ccollapsed\u003e` is used to control whether the group is collapsed by default. If it is not present, the group will be collapsed by default.\n\n- `\u003corder\u003e` is used to generate the [sidebar](#about-sidebar). It's a array of strings to specify the order of the items in a group. Every string in the array can be a file name or a folder name.\n\n  Below is an example of the `order` field:\n\n  ```yaml\n  order:\n    [\n      'overview',\n      'start',\n      'write',\n      'receive',\n      'process',\n      'ingest-and-distribute',\n      'deploy',\n      'security',\n      'reference',\n      'release-notes.md',\n    ]\n  ```\n\n  So the group will be rendered as:\n\n  - overview\n  - start\n  - write\n  - receive\n  - process\n  - ingest-and-distribute\n  - deploy\n  - security\n  - reference\n  - release-notes.md\n\n### About sidebar\n\nThe sidebar is generated base on the file structure of the `docs` folder automatically. It is generated by the following rules:\n\n- Files in `docs/` except files in `v*` and `zh` subfolders will be generated as the en latest version sidebar.\n- Files in `docs/zh` except files in `v*` subfolders will be generated as the zh latest version sidebar.\n- Files in `docs/v*` will be generated as the en v\\* sidebar.\n- Files in `docs/zh/v*` will be generated as the zh v\\* sidebar.\n\nEven though the rules are a little complicated, you don't need to worry about it. [Once a version is released](#release-a-new-version), the sidebar will be generated automatically.\n\n### Special markdown syntaxes\n\n#### {{ $version() }}\n\n`{{ $version() }}` is a special syntax that is used to display the current version of the docs. It will be replaced with the current version when the docs are built. For example:\n\n\u003e It's important to keep in mind that when using vue-style interpolation in code blocks, you should add a suffix of `-vue` to the language, such as `shell-vue`.\n\nInput:\n\n```sh\ndocker pull hstreamdb/hstream:{{ $version() }}\n```\n\nOutput:\n\n```sh\ndocker pull hstreamdb/hstream:v0.15.0\n```\n\n## Release a new version\n\nTo release a new version, all you need to do is create a new tag in the format of `v*.*.*`. For example, to release a new version `v1.0.0`, you can run:\n\n```bash\ngit tag v1.0.0\n```\n\nAnd then push the tag to the remote repository:\n\n```bash\ngit push origin v1.0.0\n```\n\nThen the CI will automatically open a PR to check out the new version from the latest docs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhstreamdb%2Fdocs-next","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhstreamdb%2Fdocs-next","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhstreamdb%2Fdocs-next/lists"}