מהו מחולל תוכן עניינים Markdown?
מחולל תוכן עניינים של Markdown קורא את הכותרות במסמך Markdown ומייצר רשימה מקוננת של קישורים שקופצים לכל סעיף אתה מדביק את ה-Markdown שלך, והכלי מחזיר בלוק מוכן לשימוש כגון רשימת תבליטים שבה כל שורה היא קישור `[Heading] (#anchor) `. זה חוסך ממך לכתוב את המתאר ביד ומניחוש מזהה העוגן שמעבד יקצה לכל כותרת.
לב הכלי הוא העוגן slug. GitHub, GitLab ורוב מחוללי האתרים הסטטיים הופכים כותרת כמו "התחלת" לזיהוי 'התחלה' על ידי הורדת הטקסט, הסרת סימני פיסוק והחלפת רווחים במקפים. מחולל זה מחיל את אותו כלל, כולל הסיומת המספרית (`-1`, `-2`) ש-GitHub מוסיף כאשר שתי כותרות חולקות slug, כך שהקישורים שהוא מייצר נפתרים למזהים המדויקים שדף README או docs שלך יעבד. הוא קורא את שתי כותרות ה-ATX (שורות שמתחילות ב-`#`) וכותרות Setext (טקסט עם קו תחתון ב-`=` או `-`), והוא מתעלם מכל `#` המופיע בתוך בלוק קוד מגודר. כותרות הנושאות עיצוב מוטבע מטופלות באותו אופן: קישור, טקסט מודגש, קוד מוטבע או תמונה בתוך כותרת מצטמצמת לטקסט הפשוט שלה עבור התווית, והעוגן בנוי מאותה מחרוזת מנוקה, כך שהשניים תמיד מסכימים.
הכל פועל בדפדפן שלך ה-Markdown שאתה מדביק מנותח עם JavaScript בצד הלקוח ולעולם לא עוזב את המכשיר שלך, כך שאין העלאה, אין חשבון ואין מעקב אחר התוכן שלך הכלי עובד במצב לא מקוון לאחר טעינת הדף, מאפשר לך לבחור את רמות הכותרת לכלול, לעבור בין רשימות תבליטים וממוספרות ולשלוט בהזחה, והוא מעדכן את המתאר ברגע שאתה משנה אפשרות.
כיצד להשתמש במחולל Markdown TOC?
הדבק את הסימון שלך
זרוק את מסמך ה-Markdown המלא שלך או README לתיבת הקלט. כותרות בתוך בלוקי קוד מגודרים מדלגים אוטומטית.
בחר את רמות הכותרת
הגדר את הרמות הרדודות והעמוקות ביותר לכלול בחירה נפוצה היא H2 עד H3, מה ששומר על המתאר קריא מבלי לרשום כל תת-סעיף.
בחר את סגנון הרשימה
עבור בין רשימה עם תבליטים או ממוספרים, הפעל או כבה את קישורי העוגן ובחר הזחה של שני רווחים, ארבעה רווחים או כרטיסיות.
העתק את תוכן העניינים
העתק את ה-Markdown שנוצר והדבק אותו ליד החלק העליון של המסמך שלך. כל ערך מקשר לעוגן הכותרת התואם.
תכונות מפתח
עוגנים תואמי GitHub
Slugs תואם את מזהי העיבודים של GitHub, כולל סיומות מספריות עבור כותרות כפולות, כך שכל קישור נפתר כהלכה.
סינון רמות
כלול רק את רמות הכותרת שאתה רוצה. קינון נמדד מהכותרת הכלולה הרדודה ביותר, כך שרשימה שמתחילה ב-H2 נשארת צמודה שמאלה.
הוזמן או לא הוזמן
פלט רשימה עם תבליטים או רשימה ממוספרת עם מונים לכל רמה, עם קישורי עוגן אופציונליים והזחה הניתנת להגדרה.
מודע לחסימת קוד
מתעלמים מכותרות הכתובות בתוך בלוקי קוד מגודרים, כך שקטעים לדוגמה לעולם אינם דולפים לתוך קווי המתאר שלך.
Frequently Asked Questions
Related Tools
HTML Table Generator
Generate an accessible HTML table from pasted CSV or tab-separated data. Add a header row, caption, striped rows, and borders, then copy the HTML and CSS. Runs client-side.
HTML to Markdown
Convert HTML to clean Markdown instantly. Turns headings, lists, links, images, blockquotes, code blocks and tables into portable GitHub Flavored Markdown. Tolerant of messy CMS markup. Runs client-side.
Markdown to HTML
Convert Markdown to clean, semantic HTML with GitHub Flavored Markdown support - tables, task lists, fenced code, heading anchors, live preview and a full HTML document export.
WordPress Readme Generator
Write a plugin readme.txt the WordPress.org directory parses, with a live preview of the listing it produces and a download when it is right.
Comments
0 comments
No comments yet. Be the first to share your thoughts!