README

本人许小克,整个项目都是我学习编程的笔记,欢迎学习交流

一 为什么要做笔记?

  • 时间是硫酸,管你是什么都能够腐化,只是快慢而已。

  • 好记性不如烂笔头

  • 他山之石可以攻玉

二 笔记规范的说明:

1 符号约定

  • <xxx> 自定义内容

  • [xxx] 可选内容

  • [<xxx>]自定义可选内容

2 图片

picture文件夹放的图片,其二级目录是个各个笔记文件夹的名字,然后图片的命名规则是:各子笔记名-内容.png/jpg等,如"git-branch-name.jpg"

3 中文注释

  • 待补充待验证最佳实践等:顾名思义

  • "似乎":表示简单验证过,但不一定正确.

4 每个笔记公共的内容:

  • 简介:优缺点等

  • 历史:怎么诞生的,出现之前老技术是怎么样的,痛点在哪儿;新技术是怎么解决的

  • 常识

三 笔记阅读方法:

推荐直接在github上阅读,可以使用带有markdown功能的工具阅读,点击跳转到笔记目录

或者在gitbook中,gitbook网站自动生成的序号和本人自定义的排版有点冲突会稍微影响阅读.

Last updated

Was this helpful?