什麼是內容產生器細分表?
Markdown 目錄產生器讀取 Markdown 文件中的標題並產生跳到每個部分的嵌套連結清單。您貼上 Markdown,工具會傳回一個即用型區塊,例如項目符號列表,其中每行都是 ` [Heading] (#anchor)` link。它可以讓您免於手動編寫大綱並猜測渲染器將分配給每個標題的錨 ID。
該工具的核心是錨點slug。 GitHub、GitLab 和大多數靜態站點產生器透過將文字縮小大小寫、刪除標點符號並用連字符替換空格,將「Getting Started」等標題轉換為 id `getting-started`。此產生器應用相同的規則,包括當兩個標題共享slug 時GitHub 添加的數字後綴(`-1`, “`-2`”),因此它產生的連結解析為您的自述文件或文件頁面將呈現的確切id。它讀取ATX 標題(以“`#` 開頭的行)和Setext 標題(以“`=` or “`-` 為下劃線的文本),並且忽略出現在圍欄代碼塊內的任何“`#`”標題採用相同的處理方式:連結、粗體文字、內聯程式碼或標題內的圖像被簡化為標籤的純文本,並且錨是由同一條乾淨的字串構建的,因此兩者始終一致。
一切都在您的瀏覽器中運行。您貼上的大關是使用客戶端 JavaScript 解析的,並且永遠不會離開您的設備,因此沒有上傳、沒有帳戶、也沒有對您的內容的追蹤。頁面載入後,該工具將離線工作,讓您選擇要包含的標題級別,在項目符號列表和編號列表之間切換,並控制縮進,並在更改選項時更新大綱。
如何使用 Markdown TOC 產生器?
貼上你的降價
將完整的 Markdown 文件或 README 放入輸入框中。圍欄代碼塊內的標題會自動跳過。
選擇標題等級
設定要包含的最淺和最深層。常見的選擇是 H2 到 H3,它可以保持大綱的可讀性,而無需列出每個小節。
選擇列表樣式
在項目符號或編號清單之間切換,開啟或關閉錨鏈接,然後選擇兩個空格、四個空格或選項卡縮排。
複製目錄
複製產生的 Markdown 並將其貼到文件頂部附近。每個條目都連結到匹配的標題錨。
主要特點
GitHub 相容錨
Slugs 匹配 GitHub 渲染的 ids,包括重複標題的數字後綴,因此每個連結都正確解析。
等級過濾
僅包含您想要的航向等級。嵌套是從包含的最淺航向測量的,因此從 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!