MkDocs 文档编辑器

最新推荐文章于 2026-06-12 08:29:42 发布
翻译 最新推荐文章于 2026-06-12 08:29:42 发布 · 2.0k 阅读 · 0
标签
#编辑器 #文档

http://www.mkdocs.org/

安装

pip install mkdocs

基本命令

命令描述
mkdocs new [dir-name]新建一个项目
mkdocs serve开启网页服务
mkdocs build创建静态网站
mkdocs help帮助文档

注意，new会在当前目录下建立项目文档，serve/build都要在项目目录下执行

配置信息

配置信息在工程目录下mkdocs.yml中修改，格式是字典格式

参数描述
site_name网页标签名
site_urlSet the canonical URL of the site. This will add a link tag with the canonical URL to the generated HTML header.
repo_url将会添加github或者Bitbucket链接
repo_name同上
edit_uri
site_description
site_descriptionmeta标签
site_authormeta标签
site_favicon设置ico，需要将ico文件放在docs/目录下
copyright设置版权信息
google_analytics设置谷歌站点分析工具
remote_branch
remote_name
pages设置路径
theme设置主题，readthedocs
theme_dir设置主题路径
docs_dir
site_dir
extra_css
extra_javascript
extra_templates
extra
use_directory_urls
strict
dev_addr
markdown_extensions

安装第三方主题

windmill主题

下载：
pip install mkdocs-windmill
在mkdocs.yml配置文件中配置主题:
theme: windmill
extra:
logo: logo的路径
version: 版本说明
article_nav_top: 默认为true，是否显示上方的Previous/Next 按钮
article_nav_bottom: 默认为true，是否显示下方的Previous/Next 按钮
history_buttons: 默认为true，是否显示历史记录

修改模板

MkDocsEditor-Web：MkDocsEditor Web客户端
02-06
MkDocsEditor-Web MkDocsEditor Web客户端。 :warning_selector: 工作正在进行中 该项目仍在进行中，尚未准备好投入生产。 开发人员指示 项目设置 npm install -g @vue/cli npm install -g @vue/cli-service-global 编译和热重装以进行开发 npm run serve chrome中的用户友好调试： https://github.com/vuejs/vue-devtools#vue-devtools 编译并最小化生产 npm run build 整理和修复文件 npm run lint 贡献 GitHub用于社交编码：
MkDocs Markdown开发工具
12-19
MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.
Yep MKdocs编辑器
weixin_43664669的博客
11-11 627
Yep MKdocs编辑器这里写自定义目录标题Yep MKdocs编辑器新的改变功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入...
Mkdocs配置教程
weixin_44633882的博客
04-21 3308
Mkdocs配置教程环境安装创建项目修改配置文件添加页面生成网站版本控制 环境 Windows 10 Python 安装 需要预先安装过Python和pip，配置好Python的环境变量。 pip install mkdocs mkdocs --version # mkdocs, version 1.1.2 from c:\applications\anaconda3\lib\site-packages\mkdocs (Python 3.7) 创建项目 mkdocs new pocGuide cd p
通过mkdocs 编辑文档
pc的博客
12-21 1168
如何编辑文档 文档使用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
MichaelAn的博客
02-13 1216
MkDocs Markdown 项目文档工具. 本文档翻译自官网mkdocs. 本文档托管于 Github. 概述 MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档. MkDocs 仍处于开发阶段....
windows安装创建mkdocs项目
qq_32934363的博客
05-09 2155
windows安装创建mkdocs项目 环境配置： windows 10 python 3.7.3 1. 下载pip和解压入口 下载PIP压缩包（不好找的话可以点击上边的“入口”进行下载），解压得到pip-9.0.1文件夹 打开该文件夹，如下目录，有一个setup.py文件 2. 执行安装pip操作 打开cmd命令窗口，切到当前刚刚解压缩的文件夹目录下，执行如下命令，完成pip安装 python setup.py install 执行如下命令，测试是否安装成功： pip -V 显示版本号等.
MKDOCS在线文档编辑器
weixin_33859504的博客
05-12 361
http://www.mkdocs.org/ api接口文档编写 ，效果非常不错 转载于:https://www.cnblogs.com/fangyuan303687320/p/5486962.html
mkdocs build 编码错误解决
weixin_43078114的博客
03-14 1179
环境： Windows10 python2.7 bug mkdocs使用MarkDown语法英文可以创建成功，但添加中文就报编码错误。 2.7版本pip是自带的 下载3.3版本手动安装pip错误依然没有解决。 开始解决问题思路错了，并不是版本问题，也不是网上说的需要自己改python安装包源码，打补丁。。 原因 使用记事本编辑源文件，虽然使用markdown语法，但文件保存格式无法选择也无法显示...
如何使用Awesome Docs打造专业技术文档？新手入门必备教程
gitblog_00929的博客
06-12 1038
在软件开发和技术项目中，**专业技术文档**是项目成功的关键因素之一。然而，许多开发者和团队在创建和维护高质量文档时常常感到困惑。今天，我将为您介绍一个强大的资源——**Awesome Docs**，这是一个精心整理的文档工具和最佳实践集合，能帮助您轻松打造专业级技术文档！🎯 ## 什么是Awesome Docs？📚 **Awesome Docs**是一个全面的文档工具集合，涵盖了从文档编
Awesome Docs核心功能解析：从API文档到站点生成器的全面工具集
最新发布
gitblog_00255的博客
06-12 281
Awesome Docs是一个精心策划的文档工具集合，为开发者和技术写作者提供从API文档生成到知识管理的完整解决方案。无论是构建API文档、创建静态网站还是优化文档质量，这个工具集都能满足各类文档需求，帮助用户轻松打造专业级文档系统。 ## 一站式文档工具生态系统 🛠️ Awesome Docs涵盖20+核心功能类别，形成完整的文档开发生命周期解决方案： - **API文档工具**：从规
如何在Mkdocs里自定义字体（霞鹜文楷）
Wcowin的博客
07-26 1962
在MKdocs中自定义字体
【详细】使用MkDocs搭建个人博客网站
weixin_45079659的博客
09-29 1738
自己开发博客网站，自定义网站
为技术项目量身定做的文档工具MkDocs
wbsu2004的博客
08-16 7447
MkDocs 是一个静态网站生成器，专门用于创建项目文档。
mkdocs 部署教程
qq_41245706的博客
11-07 2105
一、安装mkdocs pip install mkdocs 二、创建项目 mkdocs new testdocs 三、文档预览 mkdocs serve 四、更换主题 下载主题 pip install mkdocs-material mkdocs-windmill mkdocs.yml里添加: theme:  name: 'material' 五、进行mkdocs.yml配置 site_name
十分钟拥有你的私人博客！使用readthedocs和mkdocs完成你的文档托管。
Yeg1031的博客
12-27 2045
若是想要拥有一个私人博客或是在网络上共享一份技术文档，我非常推荐使用这个方案，其优点有步骤简单、门槛低，在了解具体做法后甚至还不需要十分钟即可完成整体框架的构建。
【小沐学Python】Python实现在线电子书制作（MkDocs + readthedocs + github + Markdown）
爱看书的小沐
06-10 3470
MkDocs是一个快速、简单、华丽的静态网站生成器，适用于构建项目文档。文档源文件以Markdown编写，并使用一个YAML文件来进行配置。在任何地方部署MkDocs生成完全静态的HTML网站，你可以将其部署到GitHub pages、Amzzon S3或你自己选择的其它任意地方。很棒的主题MkDocs有一堆很好看的主题。官方内置了两个主题：mkdocs和readthedocs，也可以从MkDocs wiki中选择第三方主题，或者自定义主题。实时预览你的网站。
win10 python3 install mkdocs
博客标题不能为空
04-14 1464
前言 想用mkdocs做本地资源的管理。 去mkdocs主页上，看到的安装指导并不好使。 部分原因是：我计算机上，安装其他软件时，带了很多不同版本的py2,py3. 在环境变量中指定的都是最后安装的python. 要先调整环境变量，再安装。 如果为了不影响其他已经安装软件的正常使用，最好自己写个bat, 在bat里面，将自己手工装的符合要求的python的exe路径加到path变量中。启动自己的bat, 启动python后，这时环境才符合mkdocs要求。 值得注意： python3环境变量有3个 1 p
2.为Mkdocs配置mkdocs.yml文件【非最新版】
Wcowin的博客
02-06 895
​​​​​​​作者能力有限，文章不免疏漏之处，望博友及时指出，我会尽快修改。Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml)
本地部署项目文档管理网站 MkDocs 并实现外部访问
lyxnwct的博客
07-04 641
MkDocs 是一款快速、简单且易于使用的静态站点生成器，它使用 Markdown 来编写文档，并将这些文档转换成静态网站，非常适合用于构建软件项目的文档网站，帮助团队更有效地分享信息和技术细节。本文将详细介绍如何在 Windows 系统本地部署 MkDocs 并结合路由侠实现外网访问本地部署的 MkDocs。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值