מעצב טבלאות Markdown

Markdown הפך לשפת הסימון הקלה לתיעוד, ל-README, לוויקי ולבלוגים טכניים ב-GitHub, ב-GitLab, ב-Bitbucket וב-Obsidian. אבל יצירה ותחזוקה ידנית של טבלאות נשארות מהמשימות המייגעות בתיעוד תוכנה.

בקובצי טקסט, טבלאות לא מיושרות הופכות לכאוס. מקל | חסר, ריווח לא עקבי או שורת מפריד עקומה הופכים Markdown גולמי לכמעט בלתי קריא ב-VS Code, ב-Vim, ב-Sublime Text או ב-WebStorm. כותבים נשענים על תצוגה מרונדרת רק כדי לפענח מטריצה פשוטה.

מעצב טבלאות Markdown מקצועי פותר את זה: מפרסר את הקלט לעץ תחביר (AST), מחשב רוחב לכל עמודה, מזריק ריפוד מדויק ומיישר כל מקל אנכי. קוד המקור נראה מסודר בטקסט רגיל בדיוק כמו כשהוא מתרנדר ל-HTML ב-GitHub או במחוללים כמו Astro, Docusaurus, Hugo ו-MkDocs.

בתיעוד נקודות קצה, במטריצות השוואה, בקטלוג מפתחות תצורה או במדריכי משתמש, מעצב הטבלאות החינמי של Utiliome מבטל מניפולציית רווחים ידנית וחוסך שעות יישור.

תיעוד טכני כולל פרטים ארכיטקטוניים, פרמטרי תצורה, כתובות מיקרו-שירות פנימיות, שמות עמודות בסכמה ותחזיות פיננסיות. כשמהנדסים מדביקים קטעים לכלי ווב כדי לתקן עיצוב, הם שולחים בטעות סודות לשרת צד שלישי.

ממירים ישנים עובדים במודל לקוח-שרת: הטקסט נשלח ב-POST, מעובד בקונטיינר בענן וחוזר כתשובה. גם אם המפעיל טוען שאינו שומר קלט, המטען עובר ברשתות ביניים, במאזני עומס, בזיכרון שרת ובלוגים.

Utiliome נבנה כדי לבטל את הפגיעות. מעצב הטבלאות רץ בדפדפן ב-WebAssembly ובמנועי JavaScript (V8, SpiderMonkey או JavaScriptCore). הקלט נקרא, מפורסר, מעוצב ומוצג ב-RAM המקומי ולא עוזב את המחשב.

• אפס בקשות רשת: בלשונית Network לא תראו בקשות HTTP יוצאות בזמן העיצוב.
• יכולת לא מקוונת: אחרי הטעינה הכלי עובד בלי אינטרנט, מתאים לסביבה מאובטחת, מבודדת או לעריכה בדרכים.
• מוכן לציות ארגוני: אין אחסון, לוג או העברה, ולכן צוותי אבטחה יכולים להשתמש בלי להפר הסכם סודיות או מסגרת הגנת נתונים.

Markdown המקורי של John Gruber לא כלל טבלאות. הקהילה יצרה הרחבות, עד המפרט של GitHub Flavored Markdown (GFM), הרחבה של CommonMark. שליטה בכללים מאפשרת לנצל את היישור של Utiliome.

טבלת GFM תקינה כוללת שלושה רכיבים:

1. שורת הכותרת: שורה אחת של כותרות מופרדות ב-|. מקלות חיצוניים אופציונליים במפרט, אבל אחידות איתם משפרת תאימות בין מרנדרים.
2. שורת המפריד: מיד מתחת לכותרת, מורכבת ממקפים - ומנקודתיים אופציונליות :. השורה קובעת גבולות ויישור:

• :--- או --- הם יישור לשמאל (ברירת מחדל).
• :---: הוא יישור למרכז.
• ---: הוא יישור לימין.

3. שורות הנתונים: שורות עם תאים מופרדים במקל. התא יכול לכלול הדגשה bold, נטייה *italics*, קוד `code`, קישור [text](url) וקו חוצה ~~deleted~~.

Utiliome מזהה נקודתיים קיימות בקלט ושומר אותן בעיצוב, כך שהעמודות נשארות מיושרות בלי התאמה ידנית.

מפתחים ומנהלי מוצר מייצאים דוחות, השוואות יכולות או מדדים מ-Excel, מ-Numbers או מ-Google Sheets לתיעוד או לתיאור Pull Request. הקלדה ידנית של מקלות לגיליון של 50 שורות כמעט בלתי אפשרית.

המפרסר מתמקד ביישור טבלאות מקל. בהדבקה הוא מזהה בלוקים עם שורת מפריד תקינה, מחשב רוחבי עמודות והופך שורות לא אחידות לטבלה מעוצבת, בלי ריווח ידני.

יתרונות הזרימה:

• נרמול רוחב עמודה: מחשב רוחב ומרפד תאים כך שכל המקלות מיושרים.
• שמירת יישור מפריד: שומר מחווני שמאל, מרכז וימין ובונה מחדש מקפים לפי הרוחב.
• ריפוד תאים חסרים: מרפד שורות קצרות בתאים ריקים עד לרוחב השורה הרחבה ביותר.

טבלאות שנכתבו ביד מובילות לבאגים עדינים ששוברים מרנדרים או מזיזים פריסה. Utiliome הוא מנוע עיצוב ויישור לטבלאות טקסט.

השגיאות הנפוצות והתיקון:

• מספר עמודות לא אחיד: אם בשורת נתונים חסרים תאים בגלל מקל חסר, Utiliome מזריק תאי ריפוד כדי לאחד את המטריצה.
• מקלות חיצוניים חסרים: חלק מהמרנדרים מקבלים טבלה בלי מקלות גבול, ואחרים (מפרסרים ישנים) מציגים אותה כפסקה. Utiliome מאחד גבולות בכל השורות.
• מספר מקפים לא עקבי: מפריד עם פחות מ-3 מקפים לעמודה עלול להיכשל בבדיקת GFM. Utiliome מחשב רוחב ומרחיב מקפים.
• מפרידים אנכיים לא מיושרים: ריווח לא עקבי הופך את הטבלה לכאוטית. Utiliome מחשב רוחב ומיישר מקלות.
• ערבוב רווחים וטאבים: ערבוב יוצר חוסר יישור בין עורכים עם רוחב טאב שונה. Utiliome ממיר הזחה וריפוד לרווחים סטנדרטיים.

מקל בתוך תא (למשל בפקודת מעטפת) דורש בריחה. ראו איך בורחים ממקלות, מקוד וממעברי שורה בטבלאות Markdown.

שנים שמפתחים שמחפשים כלי אונליין נאלצים לנווט באתרים עמוסי פרסומות. מחוללים ישנים מפתים בכותרת ״כלי חינם״ ואז פותחים חלונות, כופים הרשמה או נועלים ייצוא מאחורי מנוי.

Utiliome נבנה על עיקרון: כלי מפתחים צריכים להיות חינמיים, בלי חיכוך, פרטיים ומיידיים.

בין אם מעצבים טבלת API של 3 שורות או טבלה של 500 שורות בתיעוד, Utiliome נותן חוויית מפתחים בלי חומת תשלום, בלי מעקב ובבידוד נתונים מלא.

להלן המפרט הטכני של מנוע יישור הטבלאות בצד הלקוח:

כלים נלווים: יוצר טבלאות Markdown • מחולל טבלאות Markdown • מעצב טבלאות • Excel ל-Markdown.