הפער בין Markdown לעיצוב הטקסט של Jira
בצוותי אג'ייל כותבים תיעוד ב-GitHub, הערות ב-Obsidian או ב-Notion, הודעות commit, ותבניות PR ב-GitHub Flavored Markdown (GFM). Atlassian Jira, אחת מפלטפורמות ניהול הפרויקטים הנפוצות, נשענת על סימון ויקי משלה, או על צמתי Atlassian Document Format (ADF) ב-REST API.
כשמדביקים Markdown גולמי לתיאור issue, לסיכום אפיק או לתגובה, העיצוב נשבר. כותרות נשארות עם #, בלוקי קוד בלי הדגשה, bold נשאר כפול כוכביות, וטבלאות מתפרקות. מפתחים מתקנים ידנית ומבזבזים זמן.
ממיר Markdown ל-Jira החינמי של Utiliome מתרגם תחביר Markdown לסימון Jira נקי, בזמן אמת ובצד הלקוח.
מפת תרגום רכיב-רכיב
1. כותרות
ב-Markdown המבנה הוא סולמיות (# עד ######). ב-Jira קידומת מפורשת (h1. עד h6.) ואחריה רווח:
- Markdown:
# Top Level Heading$\rightarrow$ Jira:h1. Top Level Heading - Markdown:
## Section Heading$\rightarrow$ Jira:h2. Section Heading - Markdown:
### Sub-section Heading$\rightarrow$ Jira:h3. Sub-section Heading - Markdown:
#### Minor Heading$\rightarrow$ Jira:h4. Minor Heading
2. עיצוב תווים
- מודגש:
- Markdown:
Important Textאו__Important Text__ - Jira:
*Important Text*(כוכבית אחת)
- Markdown:
- נטוי:
- Markdown:
*Italicized Text*או_Italicized Text_ - Jira:
_Italicized Text_(קו תחתון)
- Markdown:
- קו חוצה:
- Markdown:
~~Deprecated Syntax~~ - Jira:
-Deprecated Syntax-(מקפים)
- Markdown:
- קוד מוטמע:
- Markdown:
`const item = true;` - Jira:
{{const item = true;}}(סוגריים מסולסלים כפולים)
- Markdown:
3. רשימות וקינון
- רשימה לא ממוינת:
- Markdown:
- Bullet itemאו* Bullet item - Jira:
* Bullet item - קינון:
Level 2 bullet,* Level 3 bullet
- Markdown:
- רשימה ממוספרת:
- Markdown:
1. First step - Jira:
# First step - קינון:
## Sub-step 1.1,### Sub-step 1.1.1
- Markdown:
4. בלוקי קוד והדגשת תחביר
Markdown משתמש בשלושה גרשיים אחוריים ושפה אופציונלית. Jira משתמש במאקרו:
- מקור Markdown:
```typescript interface UserProfile { id: string; role: 'admin' | 'developer'; } - פלט Jira:
{code:typescript} interface UserProfile { id: string; role: 'admin' | 'developer'; } {code}
בלי ציון שפה, Utiliome עוטפת ב-{code}...{code} גנרי.
5. טבלאות
ב-Markdown מפרידים ב-| ושורה מקווקוות לכותרת. ב-Jira תאי כותרת בצינור כפול (||) ותאי גוף בצינור בודד (|):
ב-Markdown כותרות מופרדות בשורת מקפים, וב-Jira צינור כפול (||) לכותרת וצינור בודד (|) לגוף:
| תקן תחביר | שורת כותרת | שורת גוף |
|---|---|---|
| GitHub Flavored Markdown | | Parameter | Type | Required | | | userId | string | Yes | |
| Atlassian Jira Markup | || Parameter || Type || Required || | | userId | string | Yes | |
Utiliome מזהה כותרות, מסירה שורות עיצוב ומייצרת טבלת Jira תקינה.
6. קישורים, תמונות וציטוטים
- קישורים:
- Markdown:
[Atlassian Jira](https://jira.atlassian.com) - Jira:
[Atlassian Jira|https://jira.atlassian.com](מפריד|במקום סוגריים)
- Markdown:
- ציטוטים:
- Markdown:
> Critical security warning for API deployment - Jira:
bq. Critical security warning for API deployment
- Markdown:
- קו מפריד:
- Markdown:
---או*** - Jira:
----(ארבעה מקפים)
- Markdown:
למה כלים חינמיים בדפדפן מתאימים למפתחים
צוותים רוצים אמינות, אבטחה ומהירות. כלים ישנים כופים הרשמה, חומת תשלום או העלאה לשרת שמסכנת קוד ארגוני.
עם Web API ועיבוד מקומי, Utiliome רצה בתוך ארגז החול של הדפדפן. אין השהיית רשת, הפרטיות מלאה, וקטעי קוד, מפרטי API ותוכניות דרך לא עוזבים את המכשיר.
בכיוון ההפוך: איך להמיר סימון Jira ל-Markdown.