alshedivat/al-folio

Adding secondary chapter navigation on left side like just-the-docs jekyll theme

Open

#2,273 opened on Mar 13, 2024

View on GitHub
 (5 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

This will be particularly helpful for making complete chapter-based notes, and exercises, for the specific book. So, If I want to open notes for specific books, I will have chapter navigation on the left sidebar and the table of contents on the right sidebar.

image

Pitch

No response

Alternatives

No response

Additional context

No response

Contributor guide

Tech stack
htmlcssjavascriptruby
Domain
frontenddocumentation
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.
clear
Prerequisites
JekyllHTMLCSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the current navigation structure in the al folio theme, likely in ` includes/nav.html` or similar. Explore how the table of contents is implemented on the right side and adapt it for a left sidebar chapter navigation. Review any existing Jekyll plugins for chapter navigation. Check the theme's layout files in ` layouts` and ` includes` to understand the current sidebar implementation.