alshedivat/al-folio

Allow the Table of Contents to be expanded to show subsections and collapsed to hide subsections.

Open

#2,531 opened on Jun 29, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (15,603 stars) (12,991 forks)batch import
enhancementhelp wanted

Description

Have you checked that your feature request isn't already filed?

  • I read through FAQ and searched through the past issues, none of which addressed my feature request.
  • Yes, I have checked that this feature request isn't already filed.

Description & Motivation

Allow the Table of Contents to be expanded to show subsections and collapsed to hide subsections. Also add support for sub-subsections

Pitch

No response

Alternatives

No response

Additional context

No response

Contributor guide

Tech stack
htmlcssjavascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with HTML/CSS/JavaScriptunderstanding of DOM manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look into the current Table of Contents implementation in ` includes/toc.html` and the related JavaScript file (likely `assets/js/toc.js` or similar). Consider adding a toggle button or click event to expand/collapse subsections. The Jekyll theme uses Liquid templates, so you may need to adjust the HTML generation to include collapsible elements. Check existing issues or discussions for any prior attempts. The maintainers have not provided specific guidance, so you may need to propose a design.