freeCodeCamp/devdocs

Current page's table of contents

Open

#6 opened on 2013年10月28日

GitHub で見る
 (20 comments) (2 reactions) (0 assignees)Ruby (38,907 stars) (2,598 forks)batch import
featurehelp wanted

説明

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.).

コントリビューターガイド

技術スタック
javascripthtmlcss
領域
documentationfrontend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
HTMLCSSJavaScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
Examine the page structure of DevDocs documentation pages to identify how headings (<h2>, <h3>) are rendered. Look at existing frontend code (likely JavaScript) to understand how to inject a fixed positioned table of contents. Check the repository's documentation or source files like app/assets/javascripts/ for page rendering logic. Consider implementing a script that generates a TOC from heading elements and adds it to the page.
Current page's table of contents · freeCodeCamp/devdocs#6 | Good First Issue