คู่มือสมบูรณ์ในการแปลง Markdown เป็นไวยากรณ์ Atlassian Jira
ทำความเข้าใจความแตกต่างของไวยากรณ์ระหว่าง Markdown และการจัดรูปแบบข้อความของ Jira
เวิร์กโฟลว์ของนักพัฒนาในสภาพแวดล้อมวิศวกรรมแบบ Agile สมัยใหม่มักจะพึ่งพา Markdown อย่างมาก วิศวกรเขียนเอกสารทางเทคนิคในคลังเก็บโค้ดของ GitHub จดบันทึกใน Obsidian หรือ Notion ร่างข้อความ Commit ในตัวแก้ไขข้อความเทอร์มินัล และเขียนเทมเพลต Pull Request โดยใช้ GitHub Flavored Markdown (GFM) อย่างไรก็ตาม Atlassian Jira ซึ่งเป็นหนึ่งในแพลตฟอร์มการจัดการโปรเจกต์ที่ได้รับการยอมรับมากที่สุดในโลก ในอดีตมักพึ่งพาไวยากรณ์การจัดรูปแบบข้อความวิกิของตัวเอง หรือโครงสร้างโหนด Atlassian Document Format (ADF) ใน REST API endpoints
เมื่อนักพัฒนาย้ายข้อความ Markdown ดิบไปยังรายละเอียดงาน Jira สรุป Epic หรือความคิดเห็น ข้อความที่ได้มักจะผิดเพี้ยน หัวข้อ Markdown ที่ยังไม่ได้แปลงจะปรากฏเป็นข้อความธรรมดาพร้อมเครื่องหมาย # บล็อกโค้ดไม่มีการไฮไลต์ไวยากรณ์ ไวยากรณ์ตัวหนาดอกจันคู่ (**bold**) ยังคงเป็นสัญลักษณ์ดิบ และตาราง Markdown พังทลายกลายเป็นคอลัมน์ที่อ่านไม่ออก ความไม่สอดคล้องกันนี้ทำให้นักพัฒนาต้องจัดรูปแบบข้อความใหม่ด้วยตนเองในตัวแก้ไขของ Jira ซึ่งเสียเวลาวิศวกรรมที่มีค่าอย่างมาก
ตัวแปลง Markdown เป็น Jira ฟรี ของ Utiliome ช่วยแก้ปัญหานี้โดยมอบเครื่องมือแปลงไวยากรณ์อัตโนมัติฝั่งไคลเอนต์ที่ราบรื่น ซึ่งแปลงไวยากรณ์ Markdown มาตรฐานเป็นมาร์กอัป Jira ที่สะอาดตาแบบเรียลไทม์
แผนผังการแปลงไวยากรณ์ Markdown เป็น Jira แบบละเอียดทุกองค์ประกอบ
เพื่อให้เข้าใจว่า Utiliome จัดการเอกสารของคุณอย่างไร โปรดดูพฤติกรรมการแปลงตามกฎต่อไปนี้:
1. หัวข้อเอกสาร (Headings)
ใน Markdown โครงสร้างเอกสารจะถูกกำหนดโดยใช้เครื่องหมายแฮชนำหน้า (# ถึง ######) Jira ใช้คำนำหน้าหัวข้อที่ชัดเจน (h1. ถึง h6.) ตามด้วยช่องว่าง:
- Markdown:
# Top Level Heading$\rightarrow$ Jira Markup:h1. Top Level Heading - Markdown:
## Section Heading$\rightarrow$ Jira Markup:h2. Section Heading - Markdown:
### Sub-section Heading$\rightarrow$ Jira Markup:h3. Sub-section Heading - Markdown:
#### Minor Heading$\rightarrow$ Jira Markup:h4. Minor Heading
2. สไตล์ตัวอักษรและข้อความ
กฎการเน้นข้อความมีความแตกต่างกันอย่างมากระหว่าง Markdown และ Jira:
- ข้อความตัวหนา:
- Markdown:
**Important Text**หรือ__Important Text__ - Jira Markup:
*Important Text*(ดอกจันเดี่ยว)
- Markdown:
- ข้อความตัวเอียง:
- Markdown:
*Italicized Text*หรือ_Italicized Text_ - Jira Markup:
_Italicized Text_(ขีดล่างเดี่ยว)
- Markdown:
- ข้อความขีดฆ่า:
- Markdown:
~~Deprecated Syntax~~ - Jira Markup:
-Deprecated Syntax-(เครื่องหมายยัติภังค์เดี่ยว)
- Markdown:
- โค้ดอินไลน์ (Monospace):
- Markdown:
`const item = true;` - Jira Markup:
{{const item = true;}}(วงเล็บปีกกาคู่)
- Markdown:
- ตัวห้อยและตัวยก:
- Markdown:
H~2~OและX^2^ - Jira Markup:
~H2O~และ^X2^
- Markdown:
3. รายการและลำดับชั้นของรายการย่อย
รายการใน Jira markup ใช้ตัวอักษรเฉพาะสำหรับรายการหัวข้อและรายการตัวเลข:
- รายการแบบไม่มีลำดับ (Bullet):
- Markdown:
- Bullet itemหรือ* Bullet item - Jira Markup:
* Bullet item(นำหน้าด้วยดอกจัน) - รายการย่อยแบบซ้อนกันใน Jira ต้องซ้ำดอกจัน:
** Level 2 bullet,*** Level 3 bullet
- Markdown:
- รายการแบบมีลำดับ (ตัวเลข):
- Markdown:
1. First step - Jira Markup:
# First step(นำหน้าด้วยเครื่องหมายแฮช) - รายการตัวเลขย่อยใช้การซ้ำแฮช:
## Sub-step 1.1,### Sub-step 1.1.1
- Markdown:
- รายการแบบผสม:
- รายการตัวเลขที่มีจุดย่อยซ้อนอยู่ จะแปลงใน Jira ได้อย่างราบรื่นโดยใช้ไวยากรณ์ผสม เช่น
#* Bullet inside item 1
- รายการตัวเลขที่มีจุดย่อยซ้อนอยู่ จะแปลงใน Jira ได้อย่างราบรื่นโดยใช้ไวยากรณ์ผสม เช่น
4. บล็อกโค้ดและการไฮไลต์ไวยากรณ์หลายบรรทัด
หนึ่งในปัญหาใหญ่ที่สุดเมื่อวางบันทึกทางเทคนิคนำลงในตั๋ว Jira คือการรักษาสภาพโครงสร้างโค้ดและการไฮไลต์สี Markdown มาตรฐานใช้ Backticks สามตัวพร้อมระบุภาษา Jira markup ใช้แท็กแมโครในตัว:
- โค้ดต้นทาง Markdown:
```typescript interface UserProfile { id: string; role: 'admin' | 'developer'; } - ผลลัพธ์ Jira Markup ที่แปลงแล้ว:
{code:typescript} interface UserProfile { id: string; role: 'admin' | 'developer'; } {code}
หากไม่ได้ระบุภาษาใน Markdown Utiliome จะใช้แมโครแบบทั่วไป {code}...{code} ใน Jira โดยอัตโนมัติ
5. ตารางข้อมูลและคอลัมน์
ตาราง Markdown ใช้แนวเส้นแนวตั้ง (|) และแถวแบ่งหัวข้อ Jira wiki markup แยกเซลล์หัวข้อออกจากเซลล์ข้อมูลธรรมดาโดยใช้แนวเส้นแนวตั้งคู่ (||) สำหรับหัวข้อ และแนวเส้นแนวตั้งเดี่ยว (|) สำหรับแถวข้อมูล:
- โค้ดต้นทาง Markdown:
| Parameter | Type | Required | | :--- | :--- | :--- | | userId | string | Yes | | timeoutMs | number | No | - ผลลัพธ์ Jira Markup ที่แปลงแล้ว:
|| Parameter || Type || Required || | userId | string | Yes | | timeoutMs | number | No |
Utiliome ตรวจหาหัวข้อตาราง ลบเส้นจัดรูปแบบ และสร้างไวยากรณ์ตาราง Jira ที่สมบูรณ์แบบโดยอัตโนมัติ
6. ไฮเปอร์ลิงก์ รูปภาพ และกล่องข้อความ
- ไฮเปอร์ลิงก์:
- Markdown:
[Atlassian Jira](https://jira.atlassian.com) - Jira Markup:
[Atlassian Jira|https://jira.atlassian.com](คั่นด้วย|แทนที่จะเป็นวงเล็บ)
- Markdown:
- คำนิยม (Blockquotes):
- Markdown:
> Critical security warning for API deployment - Jira Markup:
{quote}Critical security warning for API deployment{quote}หรือกล่องพาเนล เช่น{panel:title=Warning}Critical security warning for API deployment{panel}
- Markdown:
- เส้นแบ่งแนวนอน:
- Markdown:
---หรือ*** - Jira Markup:
----(เครื่องหมายยัติภังค์ 4 ตัว)
- Markdown:
ทำไมเครื่องมือฟรีที่ทำงานในเบราว์เซอร์ถึงได้รับความนิยมจากนักพัฒนา
ทีมวิศวกรให้ความสำคัญกับความน่าเชื่อถือ ความปลอดภัย และความเร็ว ยูทิลิตี้เว็บแบบดั้งเดิมมักบังคับให้ผู้ใช้กรอกแบบฟอร์มลงทะเบียน เจอป๊อปอัปให้ชำระเงิน หรืออัปโหลดเอกสารไปยังเซิร์ฟเวอร์ ซึ่งสร้างความเสี่ยงด้านความปลอดภัยสำหรับคลังโค้ดระดับองค์กร
ด้วยการใช้ความสามารถของเบราว์เซอร์สมัยใหม่ (เช่น JavaScript Web APIs, การแยกวิเคราะห์ DOM ในเครื่อง และการประมวลผล WebAssembly) Utiliome ทำงานในแซนด์บ็อกซ์ในเบราว์เซอร์ของคุณ 100% สถาปัตยกรรมนี้ช่วยขจัดความล่าช้าของเครือข่าย รับประกันความเป็นส่วนตัวของข้อมูล 100% และมั่นใจได้ว่าโค้ด ข้อกำหนด API ภายใน และแผนงานที่สำคัญจะไม่ถูกส่งออกจากอุปกรณ์ของคุณ