当前位置: 首页 > 科技观察

那些看似高端的项目文档和个人博客,原来都是用的这些技术

时间:2023-03-19 23:01:44 科技观察

1。前言昨天偷偷分享了一个关于微信支付的开发包,PaymentSpringBoot。有同学问文档是用什么做的,那我今天就来分享一下程序员写项目文档的工具。无论是内部工作记录还是开源分享,都非常有用。2.MarkDownMarkDown可以使用非常简单的语法来打字文本、代码块、数学公式,甚至可以实现流程图和思维导图。它简单易学,快速方便。以下为MarkDown原图:MarkDown源码对应预览版MarkDown:渲染后的MarkDown可以结合MarkDown编辑器的快捷键,基本上可以在指尖编辑漂亮的文档。胖哥用Markdown写了上百篇文章公众号。无论您是新手还是经验丰富的老手,MarkDown都是您需要掌握的东西。另外,这里推荐一个非常好用的MarkDown编辑器Typora,真的很好用,搭配图床效果也不错,谁用过就知道。3.DocsifyDocsify可以快速帮你生成文档网站。它不生成静态.html文件,所有转换都在运行时完成。如果你想开始使用它,只需创建一个index.html即可开始编写文档并直接部署在GitHubPages或GiteePages上。提供中文文档:https://docsify.js.org/#/zh-cn/如果会MarkDown,半小时就可以搭建自己的文档网站,相当简单易用。在我写这篇文章的时候,Docsify刚刚获得了开源中国2020年度最受欢迎的开源项目。4.HexoDocsify搭建文档非常方便,但是不适合搭建个人博客。上面说了,它不生成静态页面,所以不方便SEO等操作。Hexo在搭建个人博客的选择上有更好的表现。它最初是为了构建博客系统而开发的。它有多种风格可供选择,还提供了一个插件市场,您可以自定义自己的博客风格和功能。最重要的是它还提供了中文文档:https://hexo.io/zh-cn/,可以学习配置。我的个人博客是用Hexo改造的:https://felord.cnVuePress搭建博客也很不错,你也可以试试Vue风格。5.总结不要低估文档。如果能通过文档清晰的表达自己的开发思路,也是一大亮点。很多大牛的背书能力都很强,所以写写画画是不可或缺的能力。本文转载自微信公众号“码农小胖哥”,可通过以下二维码关注。转载本文请联系码农小胖公众号。