gajus/gitdown

Option to control the TOC text for specific anchors

Open

#26 建立於 2015年1月25日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)JavaScript (51 fork)github user discovery
help wanted

倉庫指標

Star
 (450 star)
PR 合併指標
 (PR 指標待抓取)

描述

Sometimes I don't want to display the full heading of a section in the table of contents. Is there or could there be an option to override the heading display?

Example: currently in the Reductio README (https://github.com/esjewett/reductio), one heading is "reductio.avg(boolean|value)". I would like this to be the heading, but in the TOC I'd like to display only "avg".

貢獻者指南

研究方向
研究 gitdown 中當前的 TOC 生成邏輯，並提出一種配置選項來覆蓋錨點顯示文字，可能通過 YAML 前置元資料或對應檔案實現。
技術棧
javascript
領域
tooling
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60