fix(docs): TOC navigation renders correct headings #2539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
liamdebeasi
approved these changes
Sep 8, 2022
brandyscarney
approved these changes
Sep 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The custom
APITOCInlinecomponent we used for rendering the headings inside of an imported markdown file are causing incorrect headings to be rendered in the TOC navigation.The problem can be seen here: https://ionicframework.com/docs/api/button ("buttonType" is displayed as a heading instead of "Properties").
Since we no longer embed the root headings in the imported markdown files, the need for the custom component is no longer required.
This PR migrates back to the
TOCInlinecomponent provided by Docusaurus for the docs pages that have not been migrated to Playground examples.