未验证 提交 cb4715be 编写于 作者: L Longda 提交者: GitHub

fixed 493, MkDocs encountered as error (#497)

* fixed 493, MkDocs encountered as error

* add mkdocs-material to requirement according to review advice
上级 da03889d
# Build documentation with MkDocs
OceanBase documentation is built with [MkDocs](https://www.mkdocs.org/). You can check [`mkdocs.yml`](mkdocs.yml) for more information.
Please install MkDocs according to [the installation documents of MkDocs](https://www.mkdocs.org/user-guide/installation/)
## Requirements
......@@ -8,13 +9,16 @@ Before installing dependencies, please make sure you have installed a recent ver
Then you can run the following command in your terminal at current directory:
$ pip install -r requirements.txt
```
$ pip install -r requirements.txt
```
## Build the documentation
You can build the documentation by running the following command:
$ mkdocs build
```
$ mkdocs build
```
This will create a new directory to store the output files, which is `site/` by default.
......@@ -22,8 +26,9 @@ This will create a new directory to store the output files, which is `site/` by
You can start a server locally by running the following command:
$ mkdocs serve
```
$ mkdocs serve
```
Open up http://127.0.0.1:8000/ in your browser, and you'll see the default home page.
## Modify pages
......
......@@ -8,3 +8,4 @@ mkdocs-git-revision-date-localized-plugin
weasyprint
mkdocs-with-pdf
qrcode
mkdocs-material
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册