freeCodeCamp/devdocs

Current page's table of contents

Open

#6 opened on 2013年10月28日

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

Repository metrics

Stars
 (38,907 stars)
PR merge metrics
 (平均マージ 23d 15h) (30d で 7 merged PRs)

説明

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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
HTMLCSSJavaScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85