steveklabnik/rustdoc

Flag: markdown no TOC

開放

#147 建立於 2017年8月10日

在 GitHub 查看
 (2 則留言) (0 個反應) (0 位負責人) (22 個分叉)github user discovery
E-Mediumbackendhelp wantedquestion

倉庫指標

星標
 (104 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

--markdown-no-toc: don't generate a table of contents

Using this flag looks like this:

$ rustdoc README.md --markdown-no-toc

When generating documentation from a Markdown file, by default, rustdoc will generate a table of contents. This flag supresses that, and no TOC will be generated.

Should we keep this flag or not?

貢獻者指南

研究方向
調查rust lang/rust倉庫中 markdown no toc標誌的當前實現。查找關於其使用的討論或問題。確定該標誌是否仍然需要，或者是否有更好的替代方案。提供建議並說明理由。
技術棧
rust
領域
documentationcli
議題類型
調研
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
較久未更新
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Rust
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70