Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Metz
oceanbase
提交
31357640
O
oceanbase
项目概览
Metz
/
oceanbase
与 Fork 源项目一致
Fork自
oceanbase / oceanbase
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
O
oceanbase
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
31357640
编写于
11月 24, 2021
作者:
L
LINxiansheng
提交者:
LINGuanRen
11月 24, 2021
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Remove mkdocs
上级
22d92d19
变更
3
展开全部
隐藏空白更改
内联
并排
Showing
3 changed file
with
0 addition
and
1323 deletion
+0
-1323
docs/README.md
docs/README.md
+0
-52
docs/mkdocs.yml
docs/mkdocs.yml
+0
-1260
docs/requirements.txt
docs/requirements.txt
+0
-11
未找到文件。
docs/README.md
已删除
100644 → 0
浏览文件 @
22d92d19
# 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
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 at current directory:
```
$ pip install -r requirements.txt
```
## Build the documentation
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.
## Start a server locally
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.
## Modify pages
### Edit a page
If you want to modify the content of a page, you can edit the markdown file in
`docs/`
directory directly.
### Modify the layout of pages
To modify the layout of pages, you need to edit
`mkdocs.yml`
.
For configuration details, see
[
MkDocs User Guide
](
https://www.mkdocs.org/user-guide/configuration/
)
.
Note the following rules when editing documents:
-
All paths in
`nav`
must be relative to the
`docs_dir`
, which is
`docs`
by default. So here
`./`
is equivalent to
[
docs
](
docs
)
.
-
All internal links must be relative paths, as MkDocs only supports regular Markdown linking syntax.
## Contribute
See
[
How to contribute
](
wiki/how_to_contribute
)
docs/mkdocs.yml
已删除
100644 → 0
浏览文件 @
22d92d19
此差异已折叠。
点击以展开。
docs/requirements.txt
已删除
100644 → 0
浏览文件 @
22d92d19
mkdocs==1.1.2
mkdocs-oceanbase
mkdocs-macros-plugin
mike
mdx_truly_sane_lists
mkdocs_latest_release_plugin
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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录