Markdown הוא הפורמט שבו אני כותב כמעט הכל - READMEs, תיעוד תוסף, הערות שחרור, תיאורי בקשות משיכה, יומן השינויים עבור WP Adminify, חצי מההערות הפנימיות שלי. זה יוצא מהדרך עבור כל מבנה מלבד אחד. ברגע שבו טבלה מעורבת, אני מפסיק לכתוב ומתחיל לספור תווי צינור, והזרימה נעלמה. הוסף עמודה לטבלה בת חמש שורות ואתה עורך שש שורות ביד, בתוספת שורת המפריד, ולא תדע אם הבנת נכון עד שהדף יעבד.
TL;DR: ה מחולל טבלאות סימון נותן לך רשת בסגנון גיליון אלקטרוני, מייצר סימון תקף בטעם GitHub תוך כדי הקלדה, ומייבא CSV, הדבקת גיליון אלקטרוני או טבלת Markdown קיימת כדי שתוכל לבנות אותה מחדש. הגדר יישור לכל עמודה בלחיצה אחת, וייצא Markdown, HTML או CSV. הכל פועל בדפדפן שלך.
הכלי קיים מכיוון שתחביר טבלה הוא החלק האחד של Markdown שבו פורמט המקור נלחם באופן פעיל בעריכה מדריך זה מכסה את אופן הפעולה של טבלאות GFM, הכללים שמחליטים אם שלך מעבד, המלכודות הבורחות ששוברות שורות וכיצד להשתמש במחולל עבור זרימות העבודה טבלאות מגיעות בדרך כלל - גיליון אלקטרוני, תוצאת שאילתה או טבלה שמישהו כבר כתב.
מה זה שולחן Markdown?
טבלת Markdown היא שלושה מרכיבים המוערמים בסדר קבוע: שורת כותרת, שורת תוחם ואפס שורות גוף או יותר. טבלאות אינן חלק מהליבה Markdown כלל - הן הרחבה המוגדרת על ידי מפרט Markdown בטעם GitHub, וזו הסיבה שטבלה יכולה להציג ב-GitHub ולצאת כצינורות מילוליים במקומות אחרים. תאים מופרדים על ידי תווי צינור, וכל שורה תופסת בדיוק שורה אחת.
| Tool | Category | Offline |
| --- | --- | --- |
| JSON Formatter | Coding | Yes |
| YAML to JSON | Data | Yes |
שורת המפריד היא החלק שהופך אותה לטבלה ולא לפסקה המכילה צינורות היא חייבת להיות השורה השנייה, היא חייבת להיות מורכבת ממקפים עם נקודתיים אופציונליים, והיא חייבת להיות בעלת אותו מספר תאים כמו הכותרת קבל כל אחד מאלה שגוי והמעבד מתייחס לכל הבלוק כטקסט רגיל - וזו הסיבה ש-" הטבלה שלי מציגה כטקסט רגיל" היא כמעט תמיד בעיה בשורה המפרידה.
טבלאות אינן חלק ממפרט CommonMark המקורי הן הגיעו כהרחבת GitHub Flavored Markdown ואומצו לאחר מכן כמעט בכל מקום: GitHub, GitLab, Bitbucket, Obsidian, Notion, Docusaurus, MkDocs, VitePress, Hugo, Jekyll, Discord, ורוב מחוללי האתרים הסטטיים. "Almost" היא המילה האופרטיבית.Renderer CommonMark מינימלי ללא הרחבות יציג את הטבלה שלך כצינורות מילוליים, והתיקון הוא לפלוט HTML במקום זאת - מה שהמחולל יכול לעשות בלחיצה אחת על כרטיסיות הפלט.
מדוע התחביר קשה יותר לתחזוקה ממה שהוא נראה
קריאת טבלת Markdown היא קלה. שמירה על אחד היא המקום שבו העלות מסתתרת, והיא מגיעה מארבעה מקומות.
מבנה חי בסימני פיסוק. אין גבול תא מלבד תו המופיע גם בביטויים רגולריים, פקודות מעטפת וסוגי איחוד TypeScript. יש לברוח מכל אחד מאלה שבתוך תא או שהשורה זוכה בשקט בעמודה.
היישור מקודד במיקום המעי הגס. נקודתיים משמאל פירושו מיושר לשמאל, נקודתיים משני הצדדים פירושו מרוכז, נקודתיים מימין פירושו מיושר לימין אין מילת מפתח לזכור אותה, וההבדל בין ---: ו :--- האם דמות אחת ברציפות אף אחד לא קורא מקרוב.
העריכה היא רב-שורה. הוספת עמודה פירושה לגעת בכל שורה בתוספת המפריד. סידור מחדש של שורות פירושו לחתוך ולהדביק ללא משוב ויזואלי. מחיקת עמודה היא חיפוש אחר הצינור ה-n בכל שורה.
יישור המקור הוא ידני. אין צורך בעמודות מרופדות - המעבדים מתעלמים מרווחים נוספים - אבל טבלאות לא מרופדות אומללות לקריאה בהבדל, אז אנשים מרפדים אותן ביד ואז מרפדים אותן מחדש בכל פעם שתוכן cell's גדל.
עורך רשת מסיר את כל הארבעה אתה עורך תאים; התחביר נוצר. זו כל הנחת היסוד של הכלי.
כיצד להשתמש במחולל טבלת סימון
שלב 1: הכנס את הנתונים שלך לרשת
שלושה מסלולים פנימה, תלוי איפה הנתונים כבר חיים.
הקלד אותו. הרשת נפתחת עם דגימה מלאה החלף את התאים, או לחץ על נקה עבור שלוש על שלוש ריק והתחל מחדש.
הדבק מגיליון אלקטרוני. פתח את חלונית הייבוא והדבק טווח מועתק מ-Excel, Google Sheets, Numbers או LibreOffice. גיליונות אלקטרוניים שמים טקסט מופרד בכרטיסיות על הלוח, והיבואן מזהה זאת באופן אוטומטי - אין צורך לומר לו באיזה מפריד אתה משתמש.
הדבק CSV או טבלה קיימת. אותו פאנל מקבל CSV, יצוא מופרד בנקודה-פסיק (ברירת המחדל באזורים רבים באירופה), טקסט מופרד בצינור וטבלאות Markdown. אם הטקסט נראה כמו טבלת Markdown - שורת כותרת ואחריה שורת מפריד - הוא מנותח כאחד, כולל יישור העמודות שלו, כך שתוכל לטעון טבלה מ-README, לבנות אותה מחדש ולהדביק אותה בחזרה.
ייבוא CSV עוקב אחר כללי RFC 4180 במקום לפצל בפסיקים בצורה נאיבית. שדה מצוטט יכול להכיל פסיקים, מעברי שורות וציטוטים כפולים המייצגים תו ציטוט מילולי. זה חשוב יותר ממה שזה נשמע: כל ייצוא המכיל כתובת, תיאור או מחיר במקום שמשתמש בפסיקים ישבור פיצול נאיבי, ולא תשים לב עד שעמודה קצרה בתא אחד. אם ה-CSV שלך גדול מספיק כדי שתרצה לבדוק אותו לפני הייבוא, ה מציג CSV פותח אותו ברשת ניתנת למיון תחילה.
שלב 2: עצב את השולחן
הפקדים מסביב לרשת מכסים את הפעולות הכואבות ב-Markdown הגולמי:
- שורה ו טור הוסף לסוף הרשת.
- החצים שליד כל שורה מזיזים אותו למעלה או למטה - שימושי להזמנת טבלת השוואה לפי מה שהחלטת שחשוב ביותר.
- כפתור המינוס בכותרת שורה או עמודה מוחק אותו, על פני כל שורה בבת אחת.
- לְהַעֲבִיר מחליף שורות ועמודות נתונים שהודבקו מדוח מכוונים לעתים קרובות בצורה לא נכונה עבור מסמך, וההעברה היא לחיצה אחת במקום הקלדה מחדש מלאה.
שלב 3: הגדר יישור לכל עמודה
כל כותרת עמודה נושאת שלושה לחצני יישור: שמאל, מרכז, ימין. לחץ על אחד כדי להחיל אותו, לחץ עליו שוב כדי לחזור למעבד 's ברירת מחדל. המחולל כותב את נקודתיים המתאימים לשורת המפריד.
כדאי להשתמש ביישור בכוונה עמודות מספריות - מחירים, ספירות, אחוזים, משכי זמן - קראו הרבה יותר טוב מיושרות ימינה, כי הספרות מסתדרות לפי ערך מקום ערכי מצב קצרים נראים מסודרים במרכז הטקסט שייך לשמאל זה לא קישוט; עמודת מספרים מיושרת לימין היא באמת מהירה יותר לסריקה עבור הערך הגדול ביותר.
שלב 4: בחר את פורמט הפלט והעתק
שלוש כרטיסיות פלט:
סימון מייצר GFM. ה עמודים מרופדים החלף פקדים אם תאים מרופדים ברווחים כך שהמקור הגולמי מתיישר בעורך מונו-חלל. ריפוד לא משנה דבר לגבי האופן שבו הטבלה מציגה - זה אך ורק עבור מי שקורא את הקובץ ב-diff. צינורות חיצוניים שולט בצינור המוביל והנגרר בכל שורה; שני הסגנונות תקפים, וסגנון הצינור המוביל הוא ללא ספק המוסכמה הנפוצה יותר.
HTML מייצר א <table> עם <thead> ו <tbody> ומוטבעת text-align סגנונות התואמים את יישור העמודות שלך השתמש בו עבור מעבדים חסרי תמיכה בטבלה, עבור תבניות דואר אלקטרוני או כאשר אתה צריך colspan ותאים מרובי שורות שMarkdown לא יכול לבטא אם אתה רוצה ללכת לכיוון השני ולהרים טבלה מתוך דף אינטרנט, HTML ל-Markdown מטפל בזה.
CSV מחזיר לך את הרשת כנתונים, מצוטטים כהלכה, להדבקה בגיליון אלקטרוני או להזנה לסקריפט.
העתק ללוח או הורד בתור א .md, .html, או .csv קובץ.
כללי הבריחה שלמעשה שוברים שולחנות
שני תווים גורמים כמעט לכל טבלת סימון מקולקלת, ושניהם מטופלים אוטומטית על ידי המחולל - אבל אתה צריך לדעת את הכללים לטבלאות שאתה עורך ביד.
הצינור. צינור מילולי בתוך תא חייב להיות כתוב כ \|. ללא קו נטוי אחורי, המעבד רואה מפריד עמודות והשורה שלך זוכה בתא, וזורקת כל עמודה אחריה. זה נוגס הכי קשה בתיעוד טכני, שבו תאים מכילים באופן לגיטימי דברים כמו string | null, grep foo | wc -l, או חילופין regex. הבריחה פועלת אפילו בתוך טווחי קוד backtick - מקרה נדיר שבו Markdown's הרגיל "טווחי קוד הם מילוליים" הכלל אינו חל.
הקו החדש. טבלאות GFM הן אך ורק שורה אחת בכל שורה, כך שתא לא יכול להכיל מעבר שורה אמיתי. הפתרון האוניברסלי הוא HTML <br> תָג. כאשר אתה מדביק תוכן רב שורות לרשת, המחולל מכניס עבורך את התג; כאשר אתה מייבא טבלה המכילה <br>, הוא ממיר בחזרה לשבירת שורה אמיתית בעורך כך שהתא נוח לעריכה.
שני כללים נוספים שווים התחייבות לזיכרון כי הם גורמים " הטבלה שלי לא render" דוחות שאין להם שום קשר לטבלה עצמה. ראשית, טבלה צריכה שורה ריקה לפניה כשהיא עוקבת אחר פסקה. שנית, בתוך פריט רשימה, יש להכניס את כל הטבלה לפריט הרשימה 's עמודת התוכן - אחרת הרשימה בולעת את השורה הראשונה ושורת המפריד נוחתת במקום הלא נכון.
מאיפה מגיעות טבלאות ואיך כל מקרה זורם
גיליון אלקטרוני שנשלחת
העתק את הטווח, הדבק בחלונית הייבוא, טען אותו לרשת, מחק את העמודות שאף אחד לא צריך, יישר נכון את המספרי, העתק את ה-Markdown. מתחת לדקה עבור טבלה שייקח עשר לעיצוב ידני.
תוצאת שאילתה או תגובת API
נתונים שמתחילים כ-JSON בדרך כלל צריכים קפיצה אחת. המר אותו עם JSON ל-CSV, ואז להדביק את CSV לתוך היבואן. Going the other way - טבלת Markdown שאתה צריך כנתונים - ייצוא CSV מכרטיסיות הפלט ולהפעיל אותו דרך CSV ל-JSON.
טבלה שכבר קיימת ב-README
הדבק אותו בחלונית Import.זה חוזר לרשת עם היישורים שלו שלמים, אז הוספת עמודה או סדר מחדש של שורות היא עריכה רגילה ולא שכתוב. זהו זרימת העבודה שאני משתמש בה הכי הרבה: טבלאות תיעוד גדלות שורה אחת בכל פעם במשך חודשים, ואז זקוקות לארגון מחדש בבת אחת.
טבלת השוואה שאתה כותב מאפס
התחל עם הרשת, הקלד כפי שאתה חושב, ותן לריפוד לסדר את עצמו כתיבת השוואה ברשת במקום בתחביר צינור שומרת את תשומת הלב שלך אם ההשוואה הוגנת ולא אם העמודות מסתדרות.
תיעוד שצריך לעבוד במספר מעבדים
צור את ה-Markdown עבור הפלטפורמות התומכות בטבלאות GFM, ולאחר מכן החלף את לשונית הפלט ל-HTML עבור זו שאינה עושה זאת. אותה רשת, שני יצוא, ללא הקלדה מחדש. אם הצינור שלך ממיר את Markdown ל-HTML בכל מקרה, סימון ל-HTML מראה לך בדיוק מה ההמרה מייצרת.
טבלאות סימון לעומת טבלאות HTML
| התחשבות | טבלת סימון | טבלת HTML |
|---|---|---|
| קריאות המקור | גבוה - ניתן לסריקה כטקסט רגיל | נמוך - תגיות שולטות בתוכן |
| תאים מרובי שורות | רק דרך <br> |
Native, כל תוכן בלוק |
| תאים ממוזגים | לא נתמך | colspan ו rowspan |
| יישור לכל עמודה | כן, באמצעות נקודתיים מפרידים | כן, באמצעות CSS או תכונות |
| בקרת סטיילינג | אף אחד | Css מלא |
| תמיכה ב-Renderer | הרחבת GFM, נפוצה אך לא אוניברסלית | אוניברסלי בכל מקום שבו HTML מותר |
| ידידותיות שונה | טוב, שורה אחת בכל שורה | עניים, הרבה שורות בשורה |
הכלל המעשי: השתמש ב-Markdown עד שתצטרך תא ממוזג, אלמנט בלוק בתוך תא או עיצוב ספציפי. לאחר מכן החלף את הטבלה האחת ל-HTML והשאיר את שאר המסמך לבד. רוב המעבדים של Markdown מעבירים HTML גולמי, כך שהערבוב של השניים בקובץ אחד הוא נורמלי.
הערה בנושא פרטיות
הטבלאות שאנשים בונים הן לרוב אלו שהם מעדיפים לא להעלות: תמחור שטרם הוכרז, מספר עובדים, אמות מידה פנימיות, לקוח ' נתונים שהודבקו מגיליון אלקטרוני.
המחולל הוא JavaScript בצד הלקוח הרשת, מנתח הייבוא וכל ריצת ייצוא בדף, ושום דבר שאתה מדביק לא עוזב את המכונה שלך טען אותו פעם אחת והוא ממשיך לעבוד במצב לא מקוון זה אותו עיקרון מאחורי הכל ב-Toolz.dev, ואת ההיגיון שווה לקרוא במלואו במדריך על פרטיות נתונים בכלים מקוונים. אם אתה מרכיב קבוצה רחבה יותר של כלי עזר מבוססי דפדפן לעבודה יומיומית, ה מדריך כלי קידוד וה ערכת כלים למפתחי אינטרנט לכסות את מה שעוד מרוויח סימניה.
טיפים מעשיים
שמור את הכותרת קצרה. עם ריפוד, התא הרחב ביותר בעמודה מגדיר את הרוחב של כל שורה במקור. כותרת מילולית הופכת את הקובץ הגולמי לרעש ללא תועלת רינדור.
אל תחששו מפלט לא מוספה עבור קבצים שנוצרו. אם טבלה נכתבת על ידי סקריפט ולעולם לא נקראת כמקור, כבה את הריפוד ושמור את הבתים.
מיין לפני שאתה מדביק. סידור מחדש של שורות חץ אחד-קליק בכל פעם הוא בסדר לחמש שורות ומייגע לחמישים מיין בגיליון האלקטרוני תחילה, ולאחר מכן ייבא.
צפה בשורת הכותרת הריקה. עם " השורה הראשונה היא header" כבוי, המחולל פולט כותרת ריקה מעל הנתונים שלך, כי GFM אין דרך להביע טבלה ללא כותרת. חלק מהמעבדים מראים כי בתור שורה ריקה דקה. אם זה מפריע לך, ייצא HTML במקום זאת, שאינו זקוק לכותרת כלל.
בדוק את התוצאה המעובדת, לא את המקור. מקור מרופד שנראה מושלם עדיין יכול לטעות אם לשורת המפריד יש מספר שגוי של תאים. הדבק בתצוגה המקדימה של כל פלטפורמה שבה אתה מפרסם לפני שאתה קורא לזה לעשות.
שָׁוא
איך אני יוצר טבלה ב-markdown?
טבלת Markdown צריכה שורת כותרת, שורת תוחם של מקפים ושורה אחת לכל רשומה, עם תאים מופרדים על ידי תווי צינור. מלא את הרשת במחולל והכלי כותב את התחביר הזה עבורך, כולל שורת המפריד וכל נקודתי יישור.
כיצד אוכל ליישר עמודות בטבלת סימון?
יישור מוגדר עם נקודתיים בשורת המפריד: נקודתיים משמאל מיישר שמאל, נקודתיים משני הצדדים במרכז, ונקודתיים מימין מיישר ימין. בחר יישור מכותרת עמודה בעורך ומיקום המעי הגס הנכון נוצר באופן אוטומטי.
האם אוכל להמיר טווח של Excel או Google Sheets לטבלת Markdown?
כן. העתק את התאים בגיליון האלקטרוני שלך והדבק אותם בחלונית הייבוא. גיליונות אלקטרוניים מציבים טקסט מופרד בכרטיסיות בלוח, שהיבואן מזהה אוטומטית ונטען לרשת.
איך אני מכניס תו צינור בתוך תא שולחן?
יש לברוח מצינור מילולי עם קו נטוי אחורי או שהמעבד יקרא אותו כמפריד עמודות. הקלד את הצינור כרגיל בעורך והגנרטור בורח אותו בפלט עבורך.
האם תא טבלת סימון יכול להכיל מספר שורות?
לא עם שורות חדשות אמיתיות, כי טבלאות GFM הן אך ורק שורה אחת בכל שורה. הפתרון הרגיל הוא תג הפסקת קו HTML בתוך התא, שכלי זה מכניס אוטומטית כאשר תא שאתה מדביק מכיל הפסקת שורה.
מדוע הטבלה שלי מציגה כטקסט רגיל ב-GitHub?
שורת המפריד היא כמעט תמיד הסיבה: היא חייבת להיות השורה השנייה והיא חייבת להיות בעלת אותו מספר תאים כמו הכותרת. שורה ריקה חסרה לפני הטבלה יכולה גם לעצור את העיבוד שלה כאשר הטבלה עוקבת אחר פסקה או יושבת בתוך רשימה.
האם אני צריך לרפד את העמודות כך שהמקור יתייצב?
מס 'מעבדים להתעלם רווחים נוספים, כך טבלה unpadded מציג באופן זהה. ריפוד קיים עבור בני אדם קריאת הקובץ הגולמי בעורך או diff. לכבות אותו עם החלפת הפלט מרופד אם אתה מעדיף מקור קומפקטי.
האם טבלאות סימון נתמכות בכל מקום?
טבלאות הן תוסף GitHub Flavored Markdown ולא חלק ממפרט CommonMark המקורי. GitHub, GitLab, Obsidian, Notion, Docusaurus ורוב מחוללי האתרים הסטטיים תומכים בהם, אך חלק מהמעבדים המינימליים לא. החלף את הפלט ל-HTML אם שלך הוא אחד מהם.
