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