【文件属性】：
文件名称：git-tutor：+ md = git日志中的精彩教程
文件大小：21KB
文件格式：ZIP
更新时间：2021-02-02 20:19:03
git markdown tutorial GitJavaScript
Git导师
从您的git历史记录中生成逐步降价教程
动机
在中型，个人博客等上都有大量教程。编写详细而完整的指南来构建事物有点困难，人们很懒惰，因此这些教程有时不完整，代码示例无法按原样工作（某些“先决条件”步骤） （未包含在教程中），有时它仅引导您完成一些代码，您可以在回购中找到其余代码。 但是您不知道其余的工作原理。
Git是逐步构建（提交）smth的理想工具。 git-tutor遍历提交历史并生成markdown，首先放置提交消息，然后放置提交内容。 将markdown写入您的提交消息–稍后使用单个命令即可获得不错的教程
示例教程
一些规则
保持较小的提交并解释您正在编写的几乎每一行代码
将markdown写入您的提交消息
不要跳过任何东西。 简单的复制粘贴应该可以重现您的教程结果
编写代码很有趣。 解释代码的工作方式更有趣
安装
npm i -g nodegit
npm i -g git-tutor
用法
git-tutor . > README.md
技巧和窍门
我不喜欢提交每一行代码。 我应该怎么做才能保持教程整洁？
很好，我也不喜欢。 您可以使用git add -p
【文件预览】：
git-tutor-master
----cli.js(160B)
----.gitignore(22B)
----README.md(4KB)
----.gitmodules(144B)
----test()
--------mocks()
--------snapshots()
--------update-snapshot.js(291B)
--------index.js(647B)
----.prettierrc(79B)
----LICENSE(2KB)
----package.json(741B)
----index.js(4KB)
----.npmignore(28B)
----.travis.yml(135B)
----.editorconfig(147B)
----package-lock.json(40KB)