道破——电子笔记与开发文档

1. 背景

自从参加工作并将PC作为生产工具而非游戏机之时,文本编辑器的更新换代成了折腾我的历史中的一部分,而笔记工具逐渐由txt、Word、印象笔记、GoodNote、换成现在的OneNote、各种企业的在线协同文档。发展趋势的主要特点是从纯文本到富文本、从单机到多平台再到云端共享。

2. 需求

一款符合我使用习惯的、合格的笔记工具应该保证以下几个特性:

  1. 免费
  2. 数据安全、及时备份
  3. 快速读写
  4. 多平台访问
  5. 异步云端共享
  6. 访问权限(可选)

3. 抉择

公司的文档共享解决方案是内网SVN+Word……

这又存在公司和家里文档版本不统一的问题,想统一只能肉身携带笔记本或U盘,而我又不想整理那些零零散散不易索引不易对比的不同版本的Word文档,怎么办?

首先不可否认的是,OneNote是我用过的最好用的笔记工具,但它有一个问题就是当我写完开发文档之后只能我自己看,如果想要共享给同事,存在一大堆的问题。比如同事不用OneNote、各种网络问题、共享经由邮件微信QQ等乱七八糟的应用、每多一个人我就得手动多传一次,这样的命运不得不将我安排得明明白白,OneNote的共享的的确确让我头疼不已。

所以,

在这个世界上,

如何实现我写一次、人类读无数次,

如何实现我在我的PC上记录的笔记或开发文档可以让授权用户在任意时间、任意地点访问,

结合目前众多的开源项目和我掌握的Web技术,一款基于浏览器的静态页网站几乎是我唯一的选择,它可以满足让我抽身探索人类存在于宇宙奥秘的基本需求。

3.1. 文本格式

Markdown是一种纯文本规范,能通过生成工具将纯文本转为HTML。

3.2. 编辑器

避免折腾,我只用VSCode。

3.3. 静态页生成器

Jekyll

Jekyll 是用 Ruby 写的最受欢迎的开源静态生成工具之一。实际上,Jekyll 是 GitHub 页面 的引擎,它可以让你免费用 GitHub 托管网站。

Hugo

Hugo 是另一个很受欢迎的用于搭建静态网站的开源框架。它是用 Go 语言写的。

它运行速度快、使用简单、可靠性高。如果你需要,它也可以提供更高级的主题。它还提供了一些有用的快捷方式来帮助你轻松完成任务。无论是组合展示网站还是博客网站,Hogo 都有能力管理大量的内容类型。

Hexo

Hexo 是一个有趣的开源框架,基于 Node.js。像其他的工具一样,你可以用它搭建相当快速的网站,不仅如此,它还提供了丰富的主题和插件。

VuePress

VuePress 是由 Vue.js 支持的静态网站生成工具,而 Vue.js 是一个开源的渐进式 JavaScript 框架。

如果你了解 HTML、CSS 和 JavaScript,那么你可以无压力地使用 VuePress。你应该可以找到几个有用的插件和主题来为你的网站建设开个头。此外,看起来 Vue.js 的更新一直很活跃,很多开发者都在关注 Vue.js。

以上4款生成器都拥有官方文档,且简单易用,而GitHub Pages推荐的是Jekyll,我曾经用过Hexo。

3.4. 文档版本管理

Git无敌

3.5. 文档托管平台

公司外网 GitHub Pages ,公司内网自己搭 GitLab Pages

实在不行搭Nginx或Node或Tomcat服务器,上传静态页。

4. 拍板儿

经过一天的探索和测试,最适合的解决方案:

  • Hugo作为静态网页生成器
  • VSCode作为编辑器
  • 使用Markdown文本格式
  • Git管理代码及文档
  • GitHub Pages作为托管后台

5. 开始

道破——VuePress (已放弃)

  1. 道破——Hugo
  2. 道破——VSCode Plugin——Markdown All In One
  3. 道破——Markdown
  4. 道破——Git Bash
  5. 道破——GitHub Pages

如果有帮助,请我吃碗烤冷面吧😊
郑六 - 支付宝 支付宝
郑六 - 微信 微信
  • 文章标题: 道破——电子笔记与开发文档
  • 原文作者: 郑六
  • 本文链接: /tool/note.html
  • 版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!