原文:使用mkdocs撰写技术文档并免费部署上线

新版git下的说明 由于github最近改版了,如果想在别的电脑上修改的话,使用https的方式pull下来代码后,之前想要提交改动的话只需要做一下用户名与密码的校验即可,现在如果想要使用https的方式提交改动得加一下私人的token。 创建私人的访问令牌在这里:创建私人访问令牌 然后还需要使用 gh auth进行认证才行: gh auth认证过程参考:gh auth认证 提示 本文演示使用的P ...

2020-04-18 13:23 0 1211 推荐指数:

查看详情

使用Mkdocs构建你的项目文档

使用Mkdocs构建你的项目文档 环境搭建 安装必需软件 作者是在windows下安装的,如果是linux或mac用户,官网有更详细的安装说明。 windows 10 x64 当然还有广大的windows 7/8 用户,也是适用的。 python 3.4 x86版本(必备依赖) 下载 ...

Sun Sep 10 22:49:00 CST 2017 0 3646
使用 VS Code 撰写 Markdown 文档

  众所周知, VS Code 是微软和社区一起开发的一款很优秀的高级代码编辑器。它不仅可以写出一手好代码,还能写出一篇好文章。利用 Markdown 就可以写出一篇排版美观的技术文章了。   而 Markdown 是一种很轻量化的标记语言。这种语言可以完成简单的文字排版工作。其实我觉得 ...

Wed Mar 09 00:33:00 CST 2022 1 761
为什么不使用github的wiki而是使用mkdocs文档管理?

为什么不使用github的wiki而是使用mkdocs文档管理? 目前 KSFramework 是使用mkdocs来做在线文档 而非使用github的wiki,这是为什么呢? 在windows下搭建wiki本地预览不成熟 gollum:https://github.com/gollum ...

Sat Nov 03 03:46:00 CST 2018 0 2432
在线文档生成工具 mkdocs 使用方法

简介 mkdocs 是一款在线文档生成工具,可以生成比较漂亮的在线文档。比如我个人的C++笔记就是用它生成的:https://demon90s.github.io/CppStudy/ 其实 mkdocs 功能就是把一堆 markdown 文档生成成一些 html 的静态页面。 mkdocs ...

Mon Nov 22 23:20:00 CST 2021 0 1814
为什么需要提前撰写Spec文档

书,是Joel自己blog文章的一个精选集。 Joel在这本书里谈到了很多技术性的观点,高屋建瓴地从思想 ...

Mon Jul 30 04:09:00 CST 2018 1 875
MkDocs项目文档生成器

简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 ...

Tue Nov 28 05:25:00 CST 2017 0 1372
软件(技术类)岗位简历的撰写要点

一、提亮你的技能 二、技术经历的撰写 三、教育背景 四、校园活动/社会活动 五、其他信息 六、让自己成为一名技术极客 七、应届毕业生可以应聘的软件技术类岗位 八、软件专业毕业生可以应聘的其他岗位 ...

Mon Mar 03 18:59:00 CST 2014 0 8154
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM