Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.14 KB

Standard.md

File metadata and controls

34 lines (27 loc) · 1.14 KB

规范说明文档

1、状态说明

  • [❎ ] 未完成
  • [✅ ] 已完成

2、目录说明

├── 01
│   ├── README.md
│   └── example
├── 02
│   ├── README.md
│   └── example
├── 03
│   ├── README.md
│   └── example
├── 04
│   ├── README.md
│   └── example
│       └── 1.html
  • 文件夹名与 README.md 中的知识点前面的标号一致。即:每个知识点对应一个文件夹。
  • 每个知识点的文件夹内有 README.md,是关于此知识点的文档说明。
  • 每个知识点文件夹内有 example 文件夹,里面是关于此知识点结合文档说明的例子。

3、知识点文档README.md的写法说明

  • 头部必须有一个名字,使用一级标题,即 markdown 使用 "#" 。
  • 下面的小标题使用三级标题,即 markdown 使用 "###" 。
  • 所有的代码请使用代码的格式。如 hello world
  • 文档的逻辑思路尽量清晰明了,想象这篇文档的读者是小白。
  • 配合文档,请尽量给出实例。