一、安装apache2(选装)
sudo apt-get apache2
重启Apache
sudo /etc/init.d/apache2 restart
二、安装mkdocs
sudo apt-get install python-pip (或在virtualenv中使用pip)
pip install mkdocs
三、制作文档工程框架
mkdocs new 工程名
生成如下目录结构
四、运行服务
mkdocs serve
自动开启服务地址,可直接访问:http://127.0.0.1:8000
五、自动生成html文件
mkdocs build --clean
生成如下目录结构
六、配置文件
mkdocs.yml文件
七、语法
#测试#
#一号标题#
##二号标题##
普通
**粗体**
*斜体*
>引用
>>引用中的引用
---
分割线
---
- 无序列表
+ 嵌套
* 嵌套
- 无序列表
- 无序列表
1. 有序列表
2. 有序列表
[文字连接](http://www.baidu.com)
![图片连接](http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png "GitHub Mark")
[索引超链接][1]
![图片超链接][2]
[1]:http://www.baidu.com
[2]:http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png "GitHub Mark"
<http://www.baidu.com>自动链接
```scala
var s="a"
println(a)
行内语言代码
```
段落代码
<!--注释-->
##表格
序号 | Code | 名称 | 类型
:--: | :----- | :------: | -----:
sudo apt-get apache2
重启Apache
sudo /etc/init.d/apache2 restart
二、安装mkdocs
sudo apt-get install python-pip (或在virtualenv中使用pip)
pip install mkdocs
三、制作文档工程框架
mkdocs new 工程名
生成如下目录结构
+docs
-index.md
-mkdocs.yml
四、运行服务
mkdocs serve
自动开启服务地址,可直接访问:http://127.0.0.1:8000
五、自动生成html文件
mkdocs build --clean
生成如下目录结构
+site
-404.html
-index.html
-sitemap.xml
+css
+fonts
+img
+js
+license
+mkdocs
六、配置文件
mkdocs.yml文件
site_name: 网站名称
# 生成html目录(选apache代理访问),默认当前site目录
site_dir: /var/www/html/
pages:
- [index.md, 首页]
- [about.md, 关于]
七、语法
#测试#
#一号标题#
##二号标题##
普通
**粗体**
*斜体*
>引用
>>引用中的引用
---
分割线
---
- 无序列表
+ 嵌套
* 嵌套
- 无序列表
- 无序列表
1. 有序列表
2. 有序列表
[文字连接](http://www.baidu.com)
![图片连接](http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png "GitHub Mark")
[索引超链接][1]
![图片超链接][2]
[1]:http://www.baidu.com
[2]:http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png "GitHub Mark"
<http://www.baidu.com>自动链接
```scala
var s="a"
println(a)
行内语言代码
```
段落代码
<!--注释-->
##表格
序号 | Code | 名称 | 类型
:--: | :----- | :------: | -----:
1 | 左对齐 | 居中对齐 | 右对齐
作者测试环境说明:
系统: ubuntu 14.04 LTS
pip版本: 1.5.4mkdocs版本: 0.14.0