freeCodeCamp/devdocs

Current page's table of contents

開放

#6 建立於 2013年10月28日

在 GitHub 查看貢獻者指南
 (20 則留言) (2 個反應) (0 位負責人)Ruby (2,598 個分叉)batch import
featurehelp wanted

倉庫指標

星標
 (38,907 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

Some documentations have very long pages that are difficult to browse through. We could improve this by adding a fixed-positioned table of contents which is automatically generated based on the current page's headings (<h2>, <h3>, etc.).

貢獻者指南

研究方向
檢查 DevDocs 文件頁面的頁面結構，以識別標題（<h2>、<h3>）是如何渲染的。查看現有的前端程式碼（很可能是 JavaScript），以了解如何注入一個固定定位的目錄。檢查儲存庫的文件或原始檔（如 app/assets/javascripts/）中的頁面渲染邏輯。考慮實作一個腳本，從標題元素產生目錄並將其新增到頁面中。
技術棧
javascriptcsshtml
領域
frontend
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
HTMLCSSJavaScript
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85