提交 53f7a648 编写于 作者: H He Wang 提交者: wangzelin.wzl

add docs website config (#251)

* add docs website config

* move files in doc/ to docs/
上级 49cdaf51
name: Publish docs via GitHub Pages
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v1
with:
python-version: '3.7'
architecture: 'x64'
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Build
run: mkdocs build -f docs/mkdocs.yml
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.PUBLISH_DOCS_TOKEN }}
publish_dir: site
......@@ -21,7 +21,7 @@ OceanBase Database supports the entire core business of Alipay and the core syst
## Quick start
Refer to the [Get Started guide](doc/quick-start-en.md) to try out OceanBase Database.
Refer to the [Get Started guide](docs/en/quick-start-en.md) to try out OceanBase Database.
## Documentation
......
# 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).
\ No newline at end of file
# 欢迎使用 OceanBase 文档
OceanBase is an enterprise distributed relational database with high availability, high performance, horizontal scalability, and compatibility with SQL standards.
\ No newline at end of file
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'
mkdocs==1.1.2
mkdocs-material
mkdocs-macros-plugin
mike
mdx_truly_sane_lists
mkdocs_latest_release_plugin
mkdocs-git-revision-date-localized-plugin
weasyprint
mkdocs-with-pdf
qrcode
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册