Skip to content

fongzhizhi/logkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LogKit

个人工作日志与自动总结工具 —— 用最低的编辑成本,获得最完整的日/周/月报告。

痛点

作为程序员,我们每天在 ONES、Jira 等工具上管理任务,但到了写周报、月报、晋升答辩时,仍然要从聊天记录和记忆里拼凑工作内容,耗时且不准确。
LogKit 的目标是:每天只需花几分钟做结构化记录,由脚本自动生成所有总结报告,让你既拥有过程数据,又不为写报告所累。

核心理念

  • 计划与记录合并:将每日计划与每日记录融合成一个列表,用复选框和简单字段区分状态,告别僵化的计划表。
  • 人机分离:人工编辑区与脚本生成区用 <!-- SCRIPT:START/END --> 明确边界,互不干扰。
  • 数据无关性:稳定的中间数据结构(WorkEntry)不依赖于 Markdown,未来可接入任何数据源或输出格式。

仓库内容

技术栈

  • TypeScript(Node.js)
  • Markdown AST 解析(unified / remark)
  • 模板驱动渲染(Handlebars)
  • 核心计算逻辑与 IO 完全解耦

快速开始

# 安装依赖
npm install

# 使用全局命令刷新总结文件
logkit update ./2026-04.md --all

在 Typora 中一键刷新

  1. 确保 logkit 已全局安装(npm link 或添加到 PATH)。

  2. 打开 Typora → 偏好设置 → 通用 → 高级设置 → 自定义运行命令。

  3. 添加命令:

    logkit update "${currentFile}" --all
  4. 可为此命令分配快捷键(如 Cmd+Shift+R)。

典型工作流

  1. 用 Typora 打开你的月度 Markdown 文件。
  2. ###### 日记录 下写完当天任务。
  3. 按快捷键,脚本自动填充所有日总结、周总结、月总结。
  4. 查看周趋势时直接滚动到对应表格。

项目状态

🚧 早期设计阶段,欢迎在 Issue 中提出想法。

About

程序员专用的轻量工作日志工具。Markdown 记录,CLI 自动输出日/周/月总结。

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors