Markdown Toolbox Logo Markdown Toolbox
บ้าน
บล็อก

บิทบัค README Markdown

2024-02-14

รุ่นสั้น

ในไฟล์ Bitbucket README.md ของคุณ คุณสามารถใช้ Markdown เพื่อจัดรูปแบบข้อความของคุณ นี่คือตัวอย่าง:

# ชื่อโครงการ

คำอธิบายสั้น ๆ เกี่ยวกับสิ่งที่โครงการนี้ทำและใครเป็นกลุ่มเป้าหมาย

## การติดตั้ง

```bash
npm install my-project

การใช้งาน

import my_project
my_project.start()

รุ่นยาว

บทนำ

Markdown เป็นภาษามาร์กอัปที่มีน้ำหนักเบาซึ่งมีไวยากรณ์การจัดรูปแบบข้อความธรรมดาที่สามารถแปลงเป็น HTML ได้ ใช้อย่างแพร่หลายสำหรับไฟล์ README ในที่เก็บข้อมูลบน Bitbucket


ไวยากรณ์พื้นฐาน

Markdown ช่วยให้คุณสามารถเขียนในรูปแบบข้อความธรรมดาที่อ่านง่ายและเขียนง่าย ซึ่งจากนั้นจะแปลงเป็น HTML ที่มีโครงสร้างถูกต้อง นี่คือคู่มือด่วนเกี่ยวกับพื้นฐาน:

  • หัวเรื่อง ใช้ # สำหรับหัวเรื่อง, ## สำหรับหัวเรื่องระดับสอง, และอื่น ๆ
  • ความเน้น ใช้ *ตัวเอียง* หรือ _ตัวเอียง_ สำหรับตัวเอียง, **ตัวหนา** หรือ __ตัวหนา__ สำหรับตัวหนา
  • รายการ รายการที่ไม่มีระเบียบใช้เครื่องหมายดอกจัน, เครื่องหมายบวก, และเครื่องหมายขีดกลาง (*, +, และ -) แทนกันได้เป็นเครื่องหมายรายการ รายการที่มีระเบียบใช้หมายเลข
  • ลิงค์ [ข้อความลิงค์](http://url) เพื่อสร้างลิงค์

และอีกมากมาย สำหรับไวยากรณ์ที่ละเอียดกว่า สามารถดูได้ที่ คู่มือ Markdown.


ข้อสรุป

การใช้ Markdown ในไฟล์ README ของคุณใน Bitbucket จะทำให้ไฟล์เหล่านั้นอ่านได้ง่ายและมีข้อมูลมากขึ้น โปรดจำไว้ว่าเอกสารที่มีประสิทธิภาพสามารถมีผลกระทบอย่างมากต่อการใช้งานและการนำไปใช้โครงการของคุณ