chore(v2): Define type for markdown right table of contents #3306
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
SamChou19815
commented
Aug 19, 2020
Comment on lines
+17
to
+24
| /** | ||
| * @typedef {Object} StringValuedNode | ||
| * @property {string} type | ||
| * @property {string} value | ||
| * @property {number} depth | ||
| * @property {Object} data | ||
| * @property {StringValuedNode[]} children | ||
| */ |
There was a problem hiding this comment.
Unfortunately, the Node type imported from unist doesn't seem to directly usable. The existing code seems to assume that the value field is always string. Therefore, I have to duplicate some type definition here.
|
Deploy preview for docusaurus-2 ready! Built with commit 5dfb1ae |
|
thanks :) |
slorber
added
the
pr: maintenance
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.
Motivation
Add typing for the
rightTOCin@docusaurus/types, so that it can be reference by all plugins and themes.After this diff, the blog plugin's theme API is fully typed, and we can now correctly type the
@theme/TOCcomponent. In a future diff, I plan to use the type for the theme API in docs plugin.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
This PR only adds type annotations, so there should be no runtime change.
To test the accuracy of the type, I added types to
@docusaurus/mdx-loaderwhich first produces the TOC. Then I added the type annotation to@theme/TOCcomponent. Both can pass the type checker.Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)