大家好，我是小 G。

今天跟大家分享一个可用于快速创建项目文档的开源神器：MkDocs。

https://github.com/mkdocs/mkdocs

该项目创建自 2014 年，目前 GitHub 上参与维护开发，给项目提交贡献的开发者，共有 100 多名，其 GitHub Star 数也达到了 9600+，估计很快就破万了。

这款工具希望能帮助开发者以更加快速、便捷的方式来创建项目文档，并为其生成更加简洁直观的静态站点。

此外，开发者还贴心的针对国内开发者提供了中文文档。

MkDocs 中文文档

在这一过程中，工程师无需进行过多编码操作，仅通过 Markdown 和 YAML 即可快速完成项目文档的撰写与配置。其主要核心功能如下：

任意托管

构建完全的静态 HTML 站点 , 可以将它托管到 GitHub ages, Amazon S3 等任意地方。

大量主题

默认包含大量美观的主题. 可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。

即时预览

内建的开发服务器使你在撰写文档的时候就即时预览。它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。

易于配置

可以快速配置文档主题。

交叉索引

使用 MkDocs 链接语法创建交叉索引。

---

现在工具给你们找来了，可以赶紧让同事把拖欠的文档补上了...

最后安利一波我们的公众号：GitHubDaily，目前每天都会在上面更新文章，专注于分享比较实用的开发工具与开源项目，偶尔也会聊聊技术圈内最近发生的新鲜事，感兴趣的小伙伴可以关注一下哈。

github创建项目_用了 GitHub 上这款开源神器后，创建项目文档变得 so easy！相关推荐

  1. 【GitHubDailyShare】主打小而美的功能，GitHub 上一款开源的 3D 建模

    GitHub 上一款开源的 3D 建模工具:Plasticity,主打小而美的功能,为概念艺术创作而生,可通过各类快捷操作,快速完成 3D 建模工作. GitHub:github.com/nkalle ...

  2. [sharepoint]rest api文档库文件上传，下载，拷贝，剪切，删除文件，创建文件夹，修改文件夹属性，删除文件夹，获取文档列表...

    写在前面 最近对文档库的知识点进行了整理,也就有了这篇文章,当时查找这些接口,并用在实践中,确实废了一些功夫,也为了让更多的人走更少的弯路. 系列文章 sharepoint环境安装过程中几点需要注意的 ...

  3. 基于Java毕业设计政府采购线上招投标平台源码+系统+mysql+lw文档+部署软件

    基于Java毕业设计政府采购线上招投标平台源码+系统+mysql+lw文档+部署软件 基于Java毕业设计政府采购线上招投标平台源码+系统+mysql+lw文档+部署软件 本源码技术栈: 项目架构:B ...

  4. java计算机毕业设计线上教育教学系统源码+数据库+lw文档+系统+部署

    java计算机毕业设计线上教育教学系统源码+数据库+lw文档+系统+部署 java计算机毕业设计线上教育教学系统源码+数据库+lw文档+系统+部署 本源码技术栈: 项目架构:B/S架构 开发语言:Ja ...

  5. java计算机毕业设计线上文具销售系统源程序+mysql+系统+lw文档+远程调试

    java计算机毕业设计线上文具销售系统源程序+mysql+系统+lw文档+远程调试 java计算机毕业设计线上文具销售系统源程序+mysql+系统+lw文档+远程调试 本源码技术栈: 项目架构:B/S ...

  6. java河南口腔医疗机构线上服务系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署

    java河南口腔医疗机构线上服务系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署 java河南口腔医疗机构线上服务系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署 本源 ...

  7. JAVA计算机毕业设计政府采购线上招投标平台Mybatis+源码+数据库+lw文档+系统+调试部署

    JAVA计算机毕业设计政府采购线上招投标平台Mybatis+源码+数据库+lw文档+系统+调试部署 JAVA计算机毕业设计政府采购线上招投标平台Mybatis+源码+数据库+lw文档+系统+调试部署 ...

  8. java计算机毕业设计线上旅行信息管理系统源代码+数据库+系统+lw文档

    java计算机毕业设计线上旅行信息管理系统源代码+数据库+系统+lw文档 java计算机毕业设计线上旅行信息管理系统源代码+数据库+系统+lw文档 本源码技术栈: 项目架构:B/S架构 开发语言:Ja ...

  9. 项目说事——信不信反正我信了（合作开发总结之文档）

    信不信反正我信了.这句话让我很无耐啊,是啊经历过合作开发的程序猿应该都有着同感--无耐.项目开发应该是件高兴的事,挣钱嘛.工作经验啊谁不高兴,可是问题又来了,以前只是个人开发项目啊,文档好歹写写,图好 ...

最新文章

  1. openssh配置终极一帖
  2. [译文]ASCII art with C#
  3. 8月21日科技联播：支付宝转账遭骗可一键撤回，美团欲9月20日上市，估值不少于$600亿...
  4. android 高并发弹幕,高并发实时直播弹幕研发实践
  5. php制作的ios端 跳转url,ThinkPHP 简易开发思路 MVC和URL跳转
  6. SQL注入之Mysql报错注入
  7. Delphi天气预报查询
  8. Spring框架(IoC、AOP面向接口切面)
  9. ZOJ 1730 圆桌换序
  10. 如何在 Mac 上的“照片”中更改和增强视频？
  11. 盈建科中地震波_[GMS][地震波][选波]YJK地震波反应谱分析与地震波选取
  12. linux13：（1.0k）ISO映像文件，镜像文件
  13. android连麦功能,Android IOS WebRTC 音视频开发总结（七六）-- 探讨直播低延迟低流量的粉丝连麦技术...
  14. SO逆向入门实战教程四：mfw
  15. 【c++】C语言之输入行数，输出实心菱形和空心菱形
  16. Phalcon整合beanstalk消息队列
  17. 浅谈机器学习-回归与分类的区别
  18. Android源码 SettingsEnums路径
  19. history.pushState()
  20. Arcpy批量导出shp文件属性表——使用arcpy.da.SearchCursor函数

热门文章

  1. I Love You的真正含义
  2. AGC005D ~K Perm Counting
  3. 小程序存emoji表情 不改变数据库
  4. spring源码解析五
  5. NOtePad++快捷键大全
  6. 关于反爬虫，看这一篇就够了
  7. C# cs文件表头模版
  8. CentOS上使用libtld
  9. SCOM 2012系列⑨单台服务器拓扑监控
  10. 找不到网卡eth0的解决方法