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
This commit is contained in:
He Wang
2021-08-02 16:17:46 +08:00
committed by wangzelin.wzl
parent 1f05540867
commit 38692436dc
5 changed files with 49 additions and 52 deletions

View File

@ -1,20 +0,0 @@
# 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](https://www.mkdocs.org/). 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](../CONTRIBUTING.md).

View File

@ -1,10 +0,0 @@
site_name: OceanBase 手册
repo_url: 'https://github.com/oceanbase/oceanbase'
repo_name: 'OceanBase'
edit_uri: 'edit/master/docs/'
docs_dir: './'
site_dir: '../site'
theme:
name: 'material'
nav:
- Home: 'index.md'