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
-
area-multi-tenancy p1-recommended technical-debt
難度 2/5 1-3 小時 新手友好度 74/100
維護者通常 1 天內回覆
-
Bug pulumi/pulumi-terraform-bridge R2 S2
難度 1/5 1 小時以內 新手友好度 72/100
pulumi/pulumi-terraform-bridge#3713 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 88/100
-
[Sync EN] Document the timezone of DateTime(Immutable)::createFromTimestamp() (#6074)可能已有人在做 @lacatoire 今天認領。 未關閉sync-en
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
[Sync EN] Document the timezone of DateTime(Immutable)::createFromTimestamp() (#6074)可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉sync-en
難度 2/5 1-3 小時 新手友好度 70/100
維護者通常 1 天內回覆