Redocly / Redocly/redoc

Multilevel anchor links

Open
#1,791 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Hi, @RomanHotsiy

A customer wants to navigate to markdown's headings higher then 2 level. We have to support 3, 4 and 5 levels. Can it be added somehow? Would it be hard ? Thanks

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the markdown heading and anchor-link rendering entry point, then inspect how level-1 and level-2 headings currently behave. Confirm the expected URL and navigation behavior for level-3, level-4, and level-5 headings; done means those headings produce usable anchors.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.