freeCodeCamp/devdocs

Current page's table of contents

Open

Aperta il 28 ott 2013

Vedi su GitHub
 (20 commenti) (2 reazioni) (0 assegnatari)Ruby (38.907 star) (2598 fork)batch import
featurehelp wanted

Descrizione

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

Guida contributor

Tech stack
javascripthtmlcss
Dominio
documentationfrontend
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
HTMLCSSJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65
Direzione di ricerca
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.