Support setext style md headings in menu item parsing
#629
Labels
Comments
mergify bot
pushed a commit
that referenced
this issue
Nov 9, 2021
Break up the rendering of a packages documentation into multiple pages. The root package page now renders the readme, and each type within the packages API reference is rendered on its own page. Items within the readme and types are still linkable via hash links that are scrolled to by the PackageDocs component. The rendering is broken up by splitting the incoming markdown on the `API Reference` header and then on subsequent headers within the api reference markdown string. These are then parsed into menu items and a hash map of `typeid -> type markdown content`. Adds unit tests for markdown parsing logic to ensure outputs remain stable. Removes 1MB size limit for rendering markdown documents. NOTE: [`setext`](https://github.github.com/gfm/#setext-headings) style md headings are not currently supported and will be added in a follow up. See #629 fix: #560
|
This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. |
|
@MrArnoldPalmer do you have an example you can share so that it will be easy to reproduce and resolve? |
|
settext headings are detailed in the github flavored markdown specification. As far as we know there is no package currently on construct-hub that uses them, and this should be superceded by a migration to a JSON format from jsii-docgen. |
|
This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Parsing md headers from the readme + api reference into a packages navigation items currently does not support
setextstyle headings. This causes these items to not be displayed in the left nav of a package page.The text was updated successfully, but these errors were encountered: