# README for TiDB Course 201: TiDB SQL for Developers

### Assets Folder Structure:
+ Demo scripts: `demo/`
+ Metadata information: `metadata/`
+ Asset templates: `template/`
+ Student guides: `student-guide/`
  + `diagram/`
  + `view/`
    + `en/`
      + `chapter-xx/`
    + `zh/`
      + `chapter-xx/`
    + `zh2en/`
      + `chapter-xx/`
+ `lab-guide/`
  + `diagram/`
  + `guide/`

## Student Guide View Markdown File Name Rule:
+ `01title.md`: The chapter title.
+ `99close.md`: The last slide of the chapter.
+ Other slides name them as `02.md`, `03.md`, ... and so on.

## Student Guide View Markdown Rules:
+ Presentation title: `# <content>\n`
+ L1 Bulletin: `+ <content>\n`
+ L2 Bulletin: `  + <content>\n`
+ L3 Buttelin: `    + <content>\n`
+ L4 Buttelin: `      + <content>\n`
+ L5 Buttelin: `        + <content>\n`
+ Code inline: enclosed by `backward single quote`
+ Code area: 
  + Begin by `triple backward single quote\n` on single line
    + Your optionally specify the font size (e.g: font-size:14) for code area by ```14
  + End by `triple backward single quote\n` on single line
+ Picture: `![center|right|left](diagram-uri)`
+ Any text above `************************` is treated as slide.
+ Any text below `************************` is treated as speaker notes.
+ Any content needs to escape from being translated and be highlighted, please enclose them with single back quotes, no matter they are in slide or notes sections, same as code inline:
  + For example: `Do NOT translate me`
