用更智能的方法记笔记,让代码编辑器成为您的笔记本
2023-12-22 16:35:41
最近切换了很多次做笔记的位置。大致可以分为三类:电子文档、物理笔记本和云笔记。各有优缺点,用过的都知道。最终我想基于 vscode + git 来作为日记本。vscode 提供的 markdown 的编写体验和界面都无可挑剔,缺陷也很明显:不可以像其他日记本一样同步。所以在日常的码字体验中,经常就是公司电脑上的文章,在家的电脑上就看不到。
基于这个,很容易想到同步的方法就是使用 git 进行版本控制。因为 markdown 本质上就是文本文件,git 对这种文件天性友好。
现在问题的重点就是如何高效的维护这份日记本。
一、统一管理文件系统
现在的主要目的是为了在任意电脑上能够访问到 markdown 文件,很显然,需要一套统一的文件系统,github 就是目前的首选。github 优点多多,这里不赘述,只要有两点是必须要强调的。
1. markdown文件扩展名大写
第一次接触 markdown 的小伙伴,通常会有这个错误,修改文件时不注意,输入了 md。但是代码提交之后,文件后缀还是大写。这样就会影响 markdown 的渲染。
2. vscode 中开通 github 插件
开通 github 插件,方便 git 相关的操作,我们主要使用的就是 git clone 和 git push。
二、构建私有项目
使用 vscode,我们肯定是有一个 code 文件夹的,其中有很多项目文件夹,根据使用习惯,笔者的项目文件都是使用英文创建。比如 laravel-task 、vue-source 等,这些项目均属于私有项目,是笔者学习或者工作的成果,所以 vscode 配置文件也是私有信息。
那笔记本必然也是属于私有信息,这里我们的思路就是:使用 github 上的 private 权限创建项目,利用好项目添加 collaborator 的功能,然后通过 file --> open folder 导入该项目,即可访问项目中的 md 文件。
三、编写习惯
1. 按照日期命名文件
每个文件夹放一个或若干个 md 文件,文件以日期命名,便于查找,所以要养成一个好习惯:当天写完当天记录。
2. 主题统一
我们不需要使用 vscode 的主题功能,只要创建一个 css 文件,其中代码如下:
body {
font-size: 18px !important;
}
把这个 css 文件命名为 github-blog.css 即可。以后不论使用哪一台电脑,只要 github-blog.css 放在 vscode 根目录下,就可以使自己的 markdown 拥有统一的主题。
3. 随时提交
由于 markdown 文件太小,提交到 github 上没有必要等达到一定的数量之后,再进行提交。因此,建议养好随时提交的习惯。具体步骤如下:
- 先进行 git add . 操作。
- 然后 commit with message。
- 再 push。
四、重要提示
1. markdown 文件大小限制
github 对 markdown 文件大小有限制,目前是 25MB,所以如果你的 md 文件超过这个限制,那么就需要拆分为多个 md 文件。
2. 最好添加版本控制
如果你有 git 的基础,建议在 vscode 中添加 git 管理。这样每次 commit 信息都是透明的,不容易出错。
3. 备份不可少
无论是什么样的文件,备份都是非常重要的事情,如果日记本很重要的话,建议使用数据库进行备份,比如 MySQL 或者 MongoDB。这样即便 github 服务器瘫痪,也可以通过数据库进行还原。
以上便是 vscode + git 打造私密日记本的全部步骤和方法了,如果您有任何疑问,欢迎在文章下方评论区留言。