https://github.com/cnosdb/official-website

https://github.com/cnosdb/official-website

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/cnosdb/official-website
• Owner: cnosdb
• Created: 2023-10-31T02:59:27.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-06T08:40:20.000Z (11 months ago)
• Last Synced: 2024-11-08T17:19:39.078Z (3 months ago)
• Language: TypeScript
• Homepage: https://beta.cnosdb.com
• Size: 5.38 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```

$ yarn

```

### Local Development

```

$ 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.

### Deployment

Using SSH:

```

$ USE_SSH=true yarn deploy

```

Not using SSH:

```

$ GIT_USER= yarn deploy

```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

---

由于需要自定义一些布局，所以使用了 [swizzling](https://docusaurus.io/zh-CN/docs/swizzling#what-is-safe-to-swizzle)， 使用了其 **ejecting** 的方式，即把主题原生的组件替换成自己定义的组件。