Add Table of Contents to pages for viewing via github
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
首先盘点 repository 的 Markdown 文档页面，并查看关于 GitPages 的现有 issue 讨论。评估提议的 doctoc 命令，以及放置在 level-1 标题之后的建议位置。完成意味着相关的 GitHub 查看页面具有可导航的目录，且不包含页面标题。
由索引模型根据 Issue 内容生成。
描述
Summary: There's a really easy way to do this, and keep it uptodate - this ticket is to explore whether you would accept a pull-request to implement it...
Motivation
Having seen the Table of Contents links on some docs on github, I've found them to be really useful in getting any overview of the topics covered, and then also for really easy navigation.
Examples are:
- https://github.com/catchorg/Catch2/blob/master/docs/assertions.md#top
- https://github.com/approvals/ApprovalTests.cpp/blob/master/doc/Contributing.md#top
I keep coming back to https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md to look for different types of information, and it would save a lot of time and scrolling if users could jump to the section of interest.
Alternatives considered
Searching through the existing issues, I saw #9 which said the solution was to use gitpages,
I downloaded the gitpages PDF, and it doesn't have tables of contents for sections.
And its "Read" feature gives "This site can't be reached" - ERR_CONNECTION_TIMED_OUT - https://lefticus.gitbooks.io/cpp-best-practices/content/
Given how quickly github.com loads Markdown pages, coupled with the convenience of being able to see page histories there and even possibly suggest improvements to the docs, I feel that it's preferable to add Table of Contents to each of the live pages on github.
Possible implementation
For ApprovalTests.cpp, we are using https://github.com/thlorenz/doctoc
It's easy to install:
npm install -g doctoc
Then we run it with this on Windows:
doctoc --title **Contents** .
or this on Unix:
doctoc --title '**Contents**' .
A minor enhancement is to move the generated ToC to after the level-1 heading, so that only level-2 and above headings are included in the ToC.
Consequences
The nice this is that this doesn't require all cppbestpractices contributors to have this tool.
Many edits won't change the ToC, and for those that do, doctoc could be run later by someone who has the tool. (I'd be happy to do that, but it would be better done by someone who has commit-permission on the repo)
- 主要语言
- 没有语言数据
- 星标
- 8.9k
- 派生
- 903
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
cpp-best-practices/cppbestpractices 的其他 Issue
-
Broken Link Chapter 2: Use_the_Tools_Available可能重新可做 @vishesharma20 于 172 天前认领，目前没有进行中的 PR。 未关闭
难度 1/5 1 小时以内 新手友好度 64/100
cpp-best-practices/cppbestpractices#169 · 1 条评论 ·
-
Broken Link - 11 Further Reading可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 1/5 1 小时以内 新手友好度 55/100
cpp-best-practices/cppbestpractices#168 · 1 条评论 ·
-
C++ Practice未关闭
难度 5/5 一周以上 新手友好度 10/100
-
难度 1/5 1 小时以内 新手友好度 35/100
-
难度 2/5 1-3 小时 新手友好度 45/100
cpp-best-practices/cppbestpractices#160 · 1 条评论 ·
查看 cpp-best-practices/cppbestpractices 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 88/100
-
[Sync EN] Document the timezone of DateTime(Immutable)::createFromTimestamp() (#6074)可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭sync-en
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
website
难度 1/5 1-3 小时 新手友好度 88/100
damodharg6/payledger#7 ·
-
area/mobile good first issue help wanted
难度 2/5 1-3 小时 新手友好度 74/100
-
难度 1/5 1 小时以内 新手友好度 85/100