Mervia AcademyLearn
เวิร์กช็อป Markdown 10xMarkdown 10x Workshop

Markdown 103: link, image, table และ footnoteMarkdown 103: links, images, tables, and footnotes

ใช้ GitHub-flavored Markdown สำหรับ link, image, table, footnote และ section ที่ richer ขึ้นโดยไม่ทำให้ source ดูแลยากUse GitHub-flavored Markdown for links, images, tables, footnotes, and richer README sections without making the source hard to maintain.

By now you can write a readable Markdown page. This lesson adds the parts that make a README useful on GitHub: links, images, tables, and footnotes.

These features are powerful, but the rule stays the same:

Add structure only when it helps the reader decide what to do next.

Use this shape:

[visible text](https://example.com)

Example:

Read the [Next.js documentation](https://nextjs.org/docs).

Good link text tells the reader where the link goes. Avoid "click here" because it gives no context when someone scans the page.

Better:

Read the [deployment guide](https://example.com/deploy).

Weaker:

Click [here](https://example.com/deploy).

Inside a repository, link to files by path:

See [the setup guide](docs/setup.md).

For folders:

Open the [examples folder](examples/).

Relative links survive when the repository moves to another GitHub org or domain.

Images

Images use the same shape as links, with ! at the front:

![Screenshot of the dashboard](assets/dashboard.png)

The text inside [] is alt text. Write what the image communicates, not "image" or "screenshot."

Good:

![Dashboard showing three active projects and one blocked task](assets/dashboard.png)

Weak:

![screenshot](assets/dashboard.png)

Tables

Tables are useful when you compare a small set of facts.

| Command | Use |
| --- | --- |
| `pnpm install` | Install dependencies |
| `pnpm run dev` | Start local development |
| `pnpm run build` | Check production build |

Rendered:

CommandUse
pnpm installInstall dependencies
pnpm run devStart local development
pnpm run buildCheck production build

Avoid giant tables. If a table has more than about six columns, a list or separate document may be easier to read.

Footnotes

Footnotes are good for context that matters but would interrupt the main flow.1

This project uses local-only credentials during development.[^env]

[^env]: Never commit `.env` files to a public repository.

Use them sparingly in READMEs. Most important warnings should be visible in the main text, not hidden below the page.

What is GitHub-flavored Markdown?

GitHub-flavored Markdown, often called GFM, is Markdown plus GitHub's practical additions.

The features you will use most:

  • tables
  • task lists
  • automatic link handling
  • strikethrough with ~~old text~~
  • footnotes

Example:

~~Old setup command~~

- [x] Replace with the new command

README structure with richer parts

Use links, images, and tables inside a simple outline:

# Project Name

Short description.

![Product screenshot](assets/screenshot.png)

## Quick start

| Step | Command |
| --- | --- |
| Install | `pnpm install` |
| Run | `pnpm run dev` |

## Docs

- [Setup](docs/setup.md)
- [Deployment](docs/deploy.md)

Notice the pattern: a README stays calm when the structure is simple and the rich elements serve a job.

Checkpoint

Before the final lesson, make sure you can write:

  • one external link
  • one relative link
  • one image with useful alt text
  • one small table
  • one task list

Next: Markdown 104 - build a GitHub README.

ตอนนี้คุณเขียน Markdown ที่อ่านรู้เรื่องได้แล้ว บทนี้จะเพิ่มส่วนที่ทำให้ README ใช้งานจริงบน GitHub ได้ดีขึ้น: link, image, table และ footnote

feature พวกนี้มีพลัง แต่กฎเดิมยังเหมือนเดิมครับ:

เพิ่มโครงสร้างเฉพาะตอนที่มันช่วยให้คนอ่านตัดสินใจได้ว่าจะทำอะไรต่อ

รูปแบบคือ:

[ข้อความที่เห็น](https://example.com)

ตัวอย่าง:

Read the [Next.js documentation](https://nextjs.org/docs).

link text ที่ดีควรบอกว่ากำลังพาไปที่ไหน หลีกเลี่ยงคำว่า "click here" เพราะคนที่กวาดตาอ่านจะไม่เห็น context

ดีกว่า:

Read the [deployment guide](https://example.com/deploy).

อ่อนกว่า:

Click [here](https://example.com/deploy).

ใน repository ให้ link ไปหาไฟล์ด้วย path:

See [the setup guide](docs/setup.md).

ถ้า link ไป folder:

Open the [examples folder](examples/).

relative link จะยังใช้ได้แม้ repository ย้ายไปอยู่ GitHub org หรือ domain อื่น

Image

image ใช้รูปแบบคล้าย link แต่มี ! ข้างหน้า

![Screenshot of the dashboard](assets/dashboard.png)

ข้อความใน [] คือ alt text ให้เขียนว่า image สื่ออะไร ไม่ใช่เขียนแค่ "image" หรือ "screenshot"

ดี:

![Dashboard showing three active projects and one blocked task](assets/dashboard.png)

อ่อน:

![screenshot](assets/dashboard.png)

Table

table เหมาะเวลาต้องเปรียบเทียบข้อมูลจำนวนน้อย

| Command | Use |
| --- | --- |
| `pnpm install` | Install dependencies |
| `pnpm run dev` | Start local development |
| `pnpm run build` | Check production build |

เมื่อ render แล้ว:

CommandUse
pnpm installInstall dependencies
pnpm run devStart local development
pnpm run buildCheck production build

อย่าทำ table ใหญ่เกินไป ถ้ามีเกินประมาณหก column list หรือเอกสารแยกมักอ่านง่ายกว่า

Footnote

footnote เหมาะสำหรับ context ที่มีประโยชน์ แต่ถ้าวางในประโยคหลักแล้วจะทำให้อ่านสะดุด2

This project uses local-only credentials during development.[^env]

[^env]: Never commit `.env` files to a public repository.

ใน README ควรใช้ให้น้อย warning สำคัญควรอยู่ในเนื้อหาหลัก ไม่ใช่ซ่อนอยู่ท้ายหน้า

GitHub-flavored Markdown คืออะไร?

GitHub-flavored Markdown หรือ GFM คือ Markdown ที่เพิ่ม feature เชิงปฏิบัติของ GitHub เข้าไป

ส่วนที่คุณจะใช้บ่อยที่สุด:

  • table
  • task list
  • automatic link handling
  • strikethrough ด้วย ~~old text~~
  • footnote

ตัวอย่าง:

~~Old setup command~~

- [x] Replace with the new command

README ที่มีส่วน rich แต่ยังอ่านง่าย

ใช้ link, image และ table ใน outline ที่เรียบง่าย:

# Project Name

Short description.

![Product screenshot](assets/screenshot.png)

## Quick start

| Step | Command |
| --- | --- |
| Install | `pnpm install` |
| Run | `pnpm run dev` |

## Docs

- [Setup](docs/setup.md)
- [Deployment](docs/deploy.md)

สังเกตรูปแบบครับ README จะนิ่งและอ่านง่ายเมื่อโครงสร้างหลักเรียบ ส่วนประกอบที่ rich ขึ้นมีหน้าที่ชัดเจน

จุดเช็ก

ก่อนเข้าบทสุดท้าย ลองเขียนให้ได้:

  • external link หนึ่งอัน
  • relative link หนึ่งอัน
  • image พร้อม alt text ที่มีประโยชน์
  • table เล็กหนึ่งอัน
  • task list หนึ่งชุด

บทถัดไป: Markdown 104 - สร้าง GitHub README

Footnotes

  1. The reader can finish the main sentence first, then inspect the extra context only if they care.

  2. คนอ่านจะอ่านประโยคหลักให้จบก่อน แล้วค่อยเปิดดู context เพิ่มเฉพาะเมื่อสนใจ

เข้าสู่ระบบเพื่อบันทึกความคืบหน้าSign in to track your progress

เข้าสู่ระบบSign in