docs: Fix Rendering of <AUTOGENERATED_TABLE_OF_CONTENTS> Tag on API -… #1617
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
… Markdown Features Page
|
Deploy preview for docusaurus-2 ready! Built with commit d79cb4e |
|
Deploy preview for docusaurus-preview ready! Built with commit d79cb4e |
|
Hmm, the https://deploy-preview-1617--docusaurus-preview.netlify.com doesn't seem to contain the changes. Along with the HACK, I also had some whitespace fixes in the "Language-specific Code Tabs" section which are not showing up in the deploy-preview. Maybe I am misunderstanding the purpose of the deploy preview. |
|
Docs change is only done on /next version of docs. |
endiliey
approved these changes
Jul 12, 2019
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.
For some strange reason, the first use of `<AUTOGENERATED_TABLE_OF_CONTENTS>` in the "Generating Table of Contents" section renders as two backticks.
but the second use is rendered as expected.
I searched through the entire document to see if there was a missing or an extraneous backtick anywhere. I didn't find anything wrong (maybe I missed something).
The GitHub preview renders correctly before and after this PR.
So, I am not sure what the best way to fix this is. Seems to be a bug in the markdown parser used by Docusaurus or some other bug.
Motivation
Markup not rendering on the site as expected.
Have you read the Contributing Guidelines on pull requests?
For Docusaurus: no. For React: yes.
Test Plan
Without cloning and building the Docusaurus site locally, I don't have a plan since GitHub's preview shows everything is fine but after building and deploying the site, the markdown was not translated correctly.
I am hoping a maintainer might see an alternative solution I can implement instead of using the HACK I used. If not, then I'll go to the extra length to build locally to see if a better solution is available.