He Wang 53f7a64888 add docs website config (#251)
* add docs website config

* move files in doc/ to docs/
2021-07-30 21:20:25 +08:00
..
2021-07-30 21:20:25 +08:00
2021-07-30 21:20:25 +08:00
2021-07-30 21:20:25 +08:00
2021-07-30 21:20:25 +08:00
2021-07-30 21:20:25 +08:00

OceanBase Documentation

Welcome to the OceanBase documentation!

This directory stores all the source files of OceanBase documentation website.

Starting a server locally

OceanBase documentation website is built with MkDocs. To install all dependencies, run:

$ pip install -r ./requirements.txt

Generate the site, and start a server locally:

$ mkdocs serve

Open up http://127.0.0.1:8000/ in your browser, and you'll see the default home page.

Contributing

See How to Contribute.