那些看上去高大上的项目文档和个人博客原来用了这些技术

开发 前端
昨天忙里偷闲分享了一个关于微信支付的开发包 Payment Spring Boot,有同学问文档是用什么搞的,今天就来分享一下关于程序员写项目文档的工具。无论是工作内部记录,还是开源分享都非常有用。

 [[357952]]

1. 前言

昨天忙里偷闲分享了一个关于微信支付的开发包 Payment Spring Boot,有同学问文档是用什么搞的,今天就来分享一下关于程序员写项目文档的工具。无论是工作内部记录,还是开源分享都非常有用。

2. MarkDown

MarkDown可以通过非常简单的语法来进行文字、代码块、数学公式的排版,甚至还是实现流程图、思维导图。具有简单易学、快捷方便的特点。

下面是原生的 MarkDown:

MarkDown 的源码

下面对应的是预览后的 MarkDown:

渲染后的MarkDown

配合 MarkDown 编辑器的快捷键,基本随手就可以编排出漂亮的文档。胖哥写了几百篇公众号都是用Markdown写的。无论是新手还是老手,MarkDown都是要掌握的。

另外这里推荐一款很好用的MarkDown编辑器 Typora ,真的很好用,配合图床,谁用谁知道。

3. Docsify

Docsify 可以快速帮你生成文档网站。它不会生成静态的 .html 文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages 或者Gitee Pages。它提供了中文文档:https://docsify.js.org/#/zh-cn/

如果你会MarkDown,半个小时你就能搭建一个属于你自己的文档网站,它相当简单好用。就在我写这篇文章的时候Docsify刚刚获得了 2020 年开源中国的最佳人气的开源项目。

4. Hexo

Docsify用来搭建文档是非常轻便的,但是它并不适用搭建个人博客。正如上面所言,它不会生成静态页面,因此不方便进行 SEO 等等更多的操作。在搭建个人博客的选择上Hexo具有更佳的表现,它被开发出来的初衷就是搭建博客系统,它具有很多的样式可供选择,同时提供了插件市场你可以定制自己的博客风格和功能。最关键的是它也提供了中文文档 :https://hexo.io/zh-cn/,你可以去学习配置。我的个人博客就是用Hexo自己改的:https://felord.cn

VuePress搭建博客也是非常出色的,你也可以去试试 Vue 风格的。

5. 总结

不要小看文档,如果你能把自己开发的思路通过文档清晰的表达出来,也是一个突出亮点。很多大牛都有很强的背书能力,所以写作、画图都是不可或缺的能力。

本文转载自微信公众号「码农小胖哥  」,可以通过以下二维码关注。转载本文请联系码农小胖哥公众号。

 

责任编辑:武晓燕 来源: 码农小胖哥
相关推荐

2016-06-07 13:53:43

ios苹果概念

2012-11-14 09:48:57

HBase大数据

2011-12-08 08:58:28

JavaScript

2024-03-26 13:03:16

NettyJavaNIO

2012-11-14 08:57:29

HBase

2014-07-09 16:58:38

WIFI

2022-07-05 11:17:46

零信任安全技术网络安全

2011-03-31 09:40:58

2019-12-02 12:50:52

LiFiWiFi通信网络

2010-09-02 09:32:26

私有云

2013-01-25 11:17:17

Gartner大数据传感器

2009-08-03 14:09:13

2012-09-19 13:47:53

HTML5

2011-02-18 14:43:21

人才

2010-06-25 09:19:18

云计算应用

2011-05-16 10:10:51

2011-10-11 09:33:11

计算机工作

2021-03-01 14:47:00

Linux LiteWindows发行版

2020-12-02 15:03:48

工具 UI 开发

2016-10-19 09:17:15

HTML5Javascript可视化
点赞
收藏

51CTO技术栈公众号