通过mkdocs 编辑文档

如何编辑文档

文档使用 mkdocs 进行编写。里边每一个章节都是 Markdown 格式。

mkdocs 安装

$ python --version
Python 3.8.2
$ pip --version
pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)-- 安装 mkdocs
$ pip install mkdocs-- 查看 mkdocs 是否安装成功
$ mkdocs --version
mkdocs, version 0.15.3-- 启动 mkdocs 进行预览
$ mkdocs serve-- 打包文档
$ mkdocs build
$ mkdocs build --clean

安装样式插件

# 安装依赖
pip install mkdocs mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin# 安装 结巴分词
pip install jieba

mkdocs-material 的配置

extra:search:language: 'en,zh,jp'
theme:name: materiallanguage: 'zh'logo: ./favicon.jpgfavicon: ./favicon.jpgpalette:primary: 'Light Blue'accent: 'Light Blue'feature:tabs: truefont:text: Microsoft YaHeicode: Courier Newplugins:- search- git-revision-date-localized:  # 在文档最后，添加 markdown 的最后修改时间 https://squidfunk.github.io/mkdocs-material/plugins/revision-date/type: iso_datetime
markdown_extensions: - admonition # 支持 markdown 文档的 notify 等样式 https://squidfunk.github.io/mkdocs-material/extensions/admonition/#bug- codehilite: # 给 markdown 的代码得数着色，https://squidfunk.github.io/mkdocs-material/extensions/codehilite/guess_lang: falselinenums: false- toc: # 给 markdown 标题，加上锚点 https://squidfunk.github.io/mkdocs-material/extensions/permalinks/permalink: true- footnotes- meta- def_list- pymdownx.arithmatex- pymdownx.betterem:smart_enable: all- pymdownx.caret- pymdownx.critic- pymdownx.details- pymdownx.emoji:emoji_generator: !!python/name:pymdownx.emoji.to_png#emoji_generator: !!python/name:pymdownx.emoji.to_svg#emoji_generator: !!python/name:pymdownx.emoji.to_png_sprite#emoji_generator: !!python/name:pymdownx.emoji.to_svg_sprite#emoji_generator: !!python/name:pymdownx.emoji.to_awesome#emoji_generator: !!python/name:pymdownx.emoji.to_alt- pymdownx.inlinehilite- pymdownx.magiclink- pymdownx.mark- pymdownx.smartsymbols- pymdownx.superfences- pymdownx.tasklist- pymdownx.tilde

mkdoc 命令

mkdocs new [dir-name] - 创建一个新的项目.
mkdocs serve - 编辑文档时，在线浏览.
mkdocs build - 打包发布文档 .
mkdocs build --clean - 清理，并打包发布文档 .
mkdocs -h - 打印帮助文档.

由于 mkdocs 的大版本更新，有一些好的插件暂时不支持，需要以后兼容，暂时留在这里

pip install mkdocs-autolinks-plugin

https://github.com/midnightprioriem/mkdocs-autolinks-plugin

pip install mkdocs-foo-plugin

https://www.mkdocs.org/user-guide/plugins/

基于mkdocs-material搭建个人静态博客

通过mkdocs 编辑文档相关推荐

【云原生之Docker实战】使用docker部署mkdocs项目文档工具
[云原生之Docker实战]使用docker部署mkdocs项目文档工具一.mkdocs介绍 1.mkdocs简介 2.mkdocs特点二.检查本地环境 1.检查docker版本 2.检查dock ...
javadrawstring设置字符大小_LaTex学术写作——编辑文档格式设置论文标题与摘要...
在上一篇文章中,我们介绍了如何安装LaTex以及开始创建文档的命令.今天我们就从学术写作的第一步开始讲起:如何编辑论文首页标题以及论文摘要.最近正在做论文重现的作业,我选取的论文是David Card ...
工具左侧服务列表_协作办公时代，在线编辑文档工具，安排！
小组合作的工作,如果能够在线编辑就方便多了,小伙伴们有没有这样想过呢?今天叔白就给大家介绍一款能够在线编辑文档的工具,帮助大家提高工作效率,还想说一句,阿里出品的工具,真香! 语雀「语雀」是一个文档 ...
latex 编辑文档遇到的问题
编辑IEEE期刊下的文章 1. 问题一:File ended while scanning use of \@newl@bel. (出现在修改出现错误,但是回复后仍然不能运行) 解决方法:应该是运行时 ...
Ubuntu编辑文档和查看文档
编辑文档,进入到文档所在目录 sudo vim test.txt#编辑文档的内容 cat vim test.txt#查看文档的内容 1.编辑进入vi/vim后按字母"i"或&qu ...
Office 365 小技巧：Microsoft Teams_ 就地编辑文档
Blog 地址:https://blog.51cto.com/13969817 Microsoft Teams 最大的特性是可以加强团队之间的协作能力,团队可以在同一个地方进行沟通和协作,并且与Mic ...
Word不能编辑文档怎么办，文档修改了不能保存怎么办
Microsoft Word的用户几乎覆盖全球,是一个方便的办公软件,但是在使用word过程中我们难以避免一些问题,比如word文档不能编辑,word文档不能编辑了怎么办呢?word修改了无法保存怎么 ...
多人在线编辑文档开发_腾讯文档，支持多人实时在线协同编辑
多年前,在港资公司工作需要多人协同编辑文档,用的是VPN+Google Docs,很早就体验过多人在线协同办公的便利,那时候,APP.微信,甚至智能手机,都没普及. 现在,就算没有VPN,用不了Goo ...
多人在线编辑文档开发_十个在线小工具，科研amp;工作必备神器！
有的时候,做一些网页小工具比软件客户端要好用,客户端有时候出现问题,罢工不能用,而且有的软件还非常占用内存,安装起来可能要好几个小时,所以,小编今天给大家推荐了这些在线版的小工具,非常实用,想用就打开 ...

通过mkdocs 编辑文档

如何编辑文档

mkdocs 安装

mkdoc 命令

通过mkdocs 编辑文档相关推荐

最新文章

热门文章