谈一谈|MkDocs介绍及应用
1 什么是MkDocs
MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它具有如下几个优点:
1.1 任意托管
构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。
1.2 大量主题
默认包含大量美观的主题。可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。
1.3 即时预览
内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。
1.4 易于配置
可以配置文档主题。
1.5 交叉索引
使用MkDocs链接语法创建交叉索引。
2 什么是Materialfor MkDocs
一个MkDocs的MaterialDesign主题。(A Material Design theme for MkDocs )Material 是MkDocs的主题,是针对项目文档的优秀静态网点生成器。它是基于Google的Material Design 指南搭建的。
3 安装
因为mkdocs是基于python对markdown的文档生成器,安装mkdocs之前得先安装python。
3.1Mkdocs安装
pip install mkdocs
3.2Material for MkDocs安装
pip install mkdocs-material
3.3环境配置
要在cmd上运行mkdocs还需要配置系统环境,控制面板-集团和安全-系统-高级系统设置-系统变量,找到path,添加mkdocs.exe的路径。其路径根据安装方法不同位置不同,pip安装的是在python安装目录下的scripts下。最后以管理员身份打开cmd,输入mkdocs没报错就是安装成功了。
4 用mkdocs创建静态网页
4.1项目创建
管理员模式打开cmd,输入
mkdocs new my-project
cd my-project
mkdocs serve
生成一个my-project项目文件夹,里面有docs文件夹和mkdocs.yml配置文件,会给你一个预览网址默认是http://127.0.0.1:8000/,用默认浏览器打开它就可以看见网页。
4.2网页内容配置
因为mkdocs的即时预览,你修改的配置会直接载入网页。
用管理员模式下的cmd打开mkdocs.yml进行修改
site_name: MkDocs介绍及应用 /(网页名称)
nav: /(添加次级目录)
- Home: index.md /(主页)
- Blog: mkdocs介绍.md /(其他页面)
theme: /(网页主题)
name: 'material' /(这就是我们安装的mkdocs-material)
在次级目录下还可以创建目录。
nav:
-Blog:
-Blog1: xxx.md
网页内容就是放在docs文件下的.md文件。
配置完后在my-project文件夹下用cmd输入
mkdocs build
完成后会生成一个site文件夹,这个文件夹里的内容就是生成的静态网站。
5 结语
生成的静态网站可以部署到readthedoc和github上。团队可以用这个来管理博客和文档。因为不支持中文搜索,管理博客还是有一些问题的,主要还是用来管理文档的。
- 关于R安装中文分词包安装不上的问题install.packages("tm")
- dataguard备库的数据文件的迁移实战(r8笔记第24天)
- Hive的left join、left outer join和left semi join三者的区别
- 52. Socket Server 自定义协议的简单实现 | 厚土Go学习笔记
- dataguard备库的数据文件的迁移(r8笔记第22天)
- 46. 实现一个简单的网络爬虫 | 厚土Go学习笔记
- 45. sync.Mutex 互斥和互斥锁 | 厚土Go学习笔记
- golang进度条
- 44. goroutine、channel、time的例子 | 厚土Go学习笔记
- AVL二叉树
- Golang:使用 httprouter 构建 API 服务器
- dataguard中需要注意的一些数据文件操作(r8笔记第21天)
- 42. select 的默认分支 | 厚土Go学习笔记
- 执行计划变化导致CPU负载高的问题分析 (r8笔记第20天)
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- Elasticsearch安装和配置
- Notes | QUAIDS 模型
- Stata | 520,听说你也想快点找到...
- Stata | 批量替换变量值的小技巧
- 手把手教你完成课设作业使用Pandas对海平面温度异常进行分析,小白也能看的懂
- 谈谈自学 Stata 的体会
- Latex修改字体字号的大小
- Notes | GitHub Upload Large Files
- PPT 中插入图片的几个小技巧
- Stata | 整理调查问卷修改内容清单
- LaTeX | 绘制微观经济学图形
- Python | 地址数据清理相关的库
- 【Redis数据结构 序】使用redis-py操作Redis数据库
- 【Redis数据结构 String类型】String类型生产中的应用 缓存、计数器、限速器的实现
- Redis数据结构 List 类型】List 类型生产中的应用 消息队列、排行榜、朋友圈、监控程序的实现