Markdown is a simple text based language that is both human readable and machine readable. It's a simple way for HUMANS to add special formatting codes to text so that when displayed in a markdown supported app, they appear like a well formatted MS Word documented.
For example, to make a bullet list, you can simply put a dash "-" and a space before a line, like this:
```text
- Item one
- Item two
- Item 3
```
And you probably noticed that my bullet list above is in a special box. That's because this AI Tips site supports markdown. Here's what I actually typed:
````markdown
```text
- Item one
- Item two
- Item 3
```
````
This will render the inner block *as visible text*, not as an actual code block.
Check boxes
- [x] Get up
- [x] Brush my teeth
- [ ] Enter cool AI tips on this site
````markdown
- [x] Get up
- [x] Brush my teeth
- [ ] Enter cool AI tips on this site
````
---
You've probably noticed that ChatGPT and the likes respond with nicely formatted text and with source code in very nice looking blocks with fixed space fonts and color coded syntax? That's because the AI neural network is spitting out markdown. The web UI is then rendering that markdown nicely with bod, italics, code blocks, color syntax highlighting, etc..
When you click the copy button on a response, you get the raw markdown copied. If you paste that into a markdown editor like Obsidian notes, you'll see that raw markdown. Unfortunately, all modern desktop GUI OS's try to be clever and paste formatted text, so if you're not in the right kind of editor, you'll lose the raw markdown.
But AI both generates and understands markdown and you can do a lot with that... ESPECIALLY when generating documentation for your source code projects! Specifically your standard README.MD file!
---
Here are multiple examples, each example appearing **twice** — once as a rendered code block, then again *inside* a `markdown` block so it shows as raw text. Depending on the markdown viewer, it may or may not color code the programming code syntax.
---
### ✅ HEADERS
**Rendered:**
# H1
## H2
### H3
#### H4
##### H5
###### H6
**Raw:**
```markdown
# H1
## H2
### H3
#### H4
##### H5
###### H6
```
---
### ✅ PARAGRAPHS & LINE BREAKS
**Rendered:**
First line.
Second line.
**Raw:**
```markdown
First line.
Second line.
```
---
### ✅ BOLD / ITALIC / STRIKETHROUGH
**Rendered:**
**bold**
*italic*
~~strikethrough~~
**Raw:**
```markdown
**bold**
*italic*
~~strikethrough~~
```
---
### ✅ BLOCKQUOTE
**Rendered:**
> This is a blockquote.
**Raw:**
```markdown
> This is a blockquote.
```
---
### ✅ ORDERED & UNORDERED LISTS
**Rendered:**
1. First
2. Second
* A
* B
**Raw:**
```markdown
1. First
2. Second
- A
- B
```
---
### ✅ TASK LISTS (GitHub flavored)
**Rendered:**
* [x] Done
* [ ] Not done
**Raw:**
```markdown
- [x] Done
- [ ] Not done
```
---
### ✅ INLINE CODE & CODE BLOCKS
**Rendered:**
Inline: `code`
Code block:
```js
console.log("hello");
```
**Raw:**
````markdown
Inline: `code`
Code block:
```js
console.log("hello");
```
````
---
### ✅ LINKS & IMAGES
**Rendered:**
[OpenAI](https://openai.com)

**Raw:**
```markdown
[OpenAI](https://openai.com)

```
---
### ✅ TABLE
**Rendered:**
| Name | Role | Score | Status |
| :------ | :---------- | ----: | :----- |
| Alice | Developer | 92 | ✅ Pass |
| Bob | Designer | 85 | ✅ Pass |
| Charlie | QA Engineer | 68 | ❌ Fail |
**Raw:**
```markdown
| Name | Role | Score | Status |
|:-----------|:-------------|------:|:---------|
| Alice | Developer | 92 | ✅ Pass |
| Bob | Designer | 85 | ✅ Pass |
| Charlie | QA Engineer | 68 | ❌ Fail |
```
---
### ✅ HORIZONTAL RULE
**Rendered:**
---
**Raw:**
```markdown
---
```
---
### ✅ HTML IN MARKDOWN
**Rendered:**
<div style="color:red">Red text</div>
**Raw:**
```markdown
<div style="color:red">Red text</div>
```
---
### ✅ ESCAPING MARKDOWN
**Rendered:**
\*not italic\*
**Raw:**
```markdown
\*not italic\*
```
---
### ✅ DEFINITION LIST (nonstandard)
**Rendered (if supported):**
Term
: Definition
**Raw:**
```markdown
Term
: Definition
```
AI Loves Markdown, therefore so should YOU!
By Mike
40 views
0