Markdown

Document

• Documents are fundamental artifacts in software development
  • Requirements
  • Design
  • Manual, etc.
• Tool/Format
  • MS Office documents
  • Markdown

Markdown

• A lightwight markup language
• Minimum specifications
  • headline (chapter/section/subsection)
  • Itemize
• Easy to write source codes
• Easy to write URL links

Headline

Headline level: the number of #

# Chapter

## Section

### Subsection

Itemize

Items: Lines beginning with -

- Item 1
    - Item 1.1
        - Item 1.1.1
        - Item 1.1.2
    - Item 1.2
- Item 2
- Item 3

Codes

Block of codes: The block srounded by three backquotes

```c
#include <stdio.h>

main() {
    printf("Hello\n");
}
```

Links

• URL links (external links)

[text](URL)

• Image links

![alt text](URL)

Tables

• Tables in Markdown are created using pipes (|) and dashes (-).
• The first row defines the headers.
• The second row sets the alignment.
• The following rows contain the table data.

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |

You can align columns using colons (:):

| Left     | Center   | Right    |
|:---------|:--------:|---------:|
| a        |   b      |      c   |

This renders as:

Ohters

• Google it
• Ask it to ChatGPT

Summary

• Markdown is a lightweight markup language
  • Easy to write documents
  • Easy to write code snippets
  • Easy to write URL links
  • Easy to write images
  • Easy to write tables
  • etc.