cdklabs / cdklabs/construct-hub-webapp
Support `setext` style md headings in menu item parsing
Open
priority/p2
stale
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 11
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 3
Description
Parsing md headers from the readme + api reference into a packages navigation items currently does not support [`setext`](https://github.github.com/gfm/#setext-headings) style headings. This causes these items to not be displayed in the left nav of a package page.
Contributor guide
Research direction
Locate the menu item parsing entry point that reads README and API reference Markdown, then reproduce the issue with a setext-style heading. Done means headings using this syntax produce package navigation items that appear in the page's left nav.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100