Files

He Wang 38692436dc modify mkdocs (#278 )

* remove github workflow

* update mkdocs.yml and add mkdocs.md

* add site/ to .gitignore

* leave requirements.txt in docs/

* update mkdocs.md

2021-08-02 16:18:36 +08:00

Build documentation with MkDocs

OceanBase documentation is built with MkDocs. You can check mkdocs.yml for more information.

Requirements

Before installing dependencies, please make sure you have installed a recent version of Python 3 and pip.

Then you can run the following command in your terminal:

$ pip install -r docs/requirements.txt

You can build the documentation by running the following command:

$ mkdocs build

This will create a new directory to store the output files, which is site/ by default.

You can start a server locally by running the following command:

$ mkdocs serve

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

If you want to modify the content of a page, you can edit the markdown file in docs/ directory directly.

To modify the layout of pages, you need to edit mkdocs.yml.

For configuration details, see MkDocs User Guide.

Note: docs/ is the default value of docs_dir, which means docs/ is equivalent to ./ in mkdocs.yml.