工欲善其事-3-整理技术笔记(gitbook)

工欲善其事,必先利其器。第三篇-整理技术笔记(gitbook)

这是工具系列的近期最后一篇,分享一个整理自己技术笔记的方法。

整理技术笔记的体会

从事技术开发,整理自己的技术笔记是所有研发同学共通的基本需求,大家都是如何去整理自己开发过程中的笔记,项目中的文档的呢?

我用过很多种方法,最早期用word文档,写一个个word然后整理到一个大文件夹下然后细分各个子类目录

也用过一些笔记软件,如有道云笔记、onenote、为知笔记等

已经记不清当时为什么切换这些笔记软件,应该是每个软件都有自己的优缺点,基于当时的需求换了笔记软件。

而每次切换笔记软件的确是一个痛苦的过程,每个软件的导出功能都很糟糕,毕竟软件商可不希望你换平台。

gitbook

目前我的笔记都是采用gitbook进行管理和编辑,已经有几年时间,能满足我全部的需求,整体感觉非常好,所以推荐给大家。

很多同学应该或多或少接触过gitbook,尤其是比较熟悉开源项目,很多项目的文档都是采用gitbook进行编辑,然后自动生成网页发布的。

gitbook是一命令行工具,可以生成笔记目录,然后通过markdown语法编辑笔记,使用git进行管理。这里有两个关键点,一个是markdown语法,一个是git管理。

MarkDown

MarkDown语法是一种轻量级的标记语言,使用简单的语法就可以编写出排版精美的文档,由于是文本结构,可以被git管理,而work之类的文档使用git只能作为二进制管理,不能跟踪修改,不能合并修改等等。

关于MarkDown用法就不在这里详细展开了,不过强烈建议学习,入门非常快,且非常好用。

Typora

这里给大家推荐一款markdown的编辑器,Typora,这款编辑器提供的图片自动下载保存生成相对路径的功能非常好用,可以直接复制网站图片,不用手动保存并进行路径编辑。

其他快捷操作也非常方便。

git

git管理是整理技术笔记的核心,将笔记作为源码管理,这样可以方便的进行笔记历史管理、同步、合并等等。

Working Copy

这里推荐给大家一款ipad端看源码笔记的神器,Working Copy,这是一个ipad端使用git管理源码和笔记的工具,可以很方便的查看代码,笔记,并且实现git的大多数功能。非常适合利用地铁公交等零散时间阅读或者写一些东西,比如这一篇分享。

当然这是一个收费软件,绝不是给它打广告,它的确很好用,有免费版本,大家可以试用看看。

demo

以下是我个人的笔记一级目录,将自己在开发过程中学习到的知识点和问题根据类别整理到对应的文件目录下,后面需要用到的时候可以很快的找到内容,这个在实际工作中的确省了很多的事情。

.
├── 深度学习
├── 文档工具
├── 芯片资料
├── 自动驾驶
├── 组合导航
├── AcmeUav
│   ├── 工欲善其事-1.md
│   ├── 工欲善其事-2.md
│   ├── 工欲善其事-3.md
│   ├── 使用3D地面站的编队飞行.md
│   ├── 写在开始.md
│   └── README.md
├── book.json
├── GIT
├── linux
├── Program
├── README.md
├── Robot
├── ROS
├── ROS2
├── RTOS
├── Simulation
├── SUMMARY.md
└── UAV

本公众号的文章也是由gitbook管理,然后发布的,使用markdown编辑可以直接复制到公众号的编辑器中,不用任何修改就可以得到不错的排版

到这里工具系列的分享暂时告一段落,给大家分享了

  • git及git常用实用操作
  • vscode及实用插件
  • 代码格式化的方法
  • 整理技术笔记的方法

我觉得这些都是技术开发需要的基础且实用的工具和方法,熟练的掌握可以极大的提高开发和学习的效率,建议大家可以花一些时间深入了解一下,在实际开发学习中逐渐使用。

后面将会开始无人机飞控技术的分享。

这里会不定期更新一些我整理的无人机相关知识,欢迎关注。

我的微信公众号,文章同步更新,欢迎关注。

微信公众号