https://github.com/apecloud/kubeblocks.io
https://github.com/apecloud/kubeblocks.io
docusaurus kubeblocks
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apecloud/kubeblocks.io
- Owner: apecloud
- Created: 2022-08-23T09:22:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T06:07:43.000Z (about 1 year ago)
- Last Synced: 2024-10-23T08:33:31.416Z (about 1 year ago)
- Topics: docusaurus, kubeblocks
- Language: JavaScript
- Homepage: http://kubeblocks.io/
- Size: 114 MB
- Stars: 13
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Kubeblocks docs website
This repo contains the source code of [kubeblocks website](https://kubeblocks.io). It's built by [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Contributing to Kubeblocks EN Docs
First, we have the source documentation in [Kubeblocks repo](https://github.com/apecloud/kubeblocks/tree/main/docs) and it's written in English. Any doc files modifid will trigger the Github action to run and validate the docs could be build successfully into the website.
The Github-Action there will parse the document and publish it to the Kubeblocks Website automatically.
Please follow our guides below to learn how to preview the docs in the right way.
## How to preview the docs
### 1. Requirements
* *Required*: Install [Node.js](https://nodejs.org/en/download/) version 16.14 or above (which can be checked by running `node -v`).
* *Optional*: Install vscode plugin 'Markdown Snippets for MDX and Docusaurus'.
```
https://marketplace.visualstudio.com/items?itemName=MisterMunchkin.simple-markdown-snippets
```
### 2. Run development server
``` bash
cd /path/to/kubeblocks.io
```
``` bash
yarn install
```
``` bash
yarn docs:sync
```
``` bash
yarn dev
```
By default, a browser window opens at [http://localhost:3000](http://localhost:3000). Browse the site to see what's available. The default locale is en-us;
### 3. add anthor version to website
Add a version configuration in config/versions.js, and then execute the command
`yarn docs:sync` again
``` javascript
module.exports = [
{
version: "release-0.5",
branch: "release-0.5",
sidebar: {
docs: [{ type: "autogenerated", dirName: "user_docs" }],
release_notes: [{ type: "autogenerated", dirName: "release_notes" }],
},
},
];
```