/docusaurus-operator

Build a docusaurus site for tidb operator docs

Primary LanguageJavaScript

Docusaurus Operator

👉 Documentation

I build the site to test how the docs of TiDB Operator looks like with Docusaurus and GitHub Pages. And it fares well.

It is a personal project (for study purposes!) and has nothing to do with PingCAP official docs.

Light

Night

Build

If you want to build this site from your local computer, just clone this repo and run:

npm run start

TODO

  • Migrate the site to Docusaurus
  • Separate the user manuals from reference
  • Fix admonition
  • Fix tabs
  • Add generated index pages
  • Add i18n support
  • Add versioning
  • Enable auto incremental build
  • Add site search
  • Reuse content
  • Customize styling