GitNotebook

工作记录小工具

目的

通过提交信息，来记录工作日里的点滴细节，在周末或者月末通过工具将记录的工作内容以时间维度格式化展现出来，作为周报或者月报的内容。

环境要求

1. mac下使用
2. git环境

目录结构介绍

./note 存放生成的md文档

./script 存放命令脚本，可以根据自己实际需求修改

./init.sh 初始化当前git空间需要执行的脚本

使用

1. 初始化环境，在项目根目录下执行 sh init.sh
2. 记录事项，项目目录下执行 git rec '这里是工作内容'
3. 删除最近的次提交记录，在项目根目录下执行 git del 1，最后一个参数为数字，即删除最近几次的提交记录
4. fork项目到本地后，如果想避免本地提交push到远程，可以在 init.sh 中把断开与远程仓库连接的命令反注释掉再执行一次
5. 整理周报，在项目根目录下执行 git week，进入./note 文件夹中或在命令行中查看执行结果
6. 整理月报，在项目根目录下执行 git month，进入./note 文件夹中或在命令行中查看执行结果

执行示例

1. fork 本项目
2. clone 项目到本地
3. 项目根目录下执行命令 sh init.sh
4. 执行命令 git week

命令行输出如下：

在./note文件夹中出现名称为 2020-07-01 TO 2020-07-03.md 的 Markdown 格式文件

预览如下：