-
Notifications
You must be signed in to change notification settings - Fork 194
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Bug] Fix support for markdown template #239
Merged
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
Size Change: +12.9 kB (0%) Total Size: 3.68 MB
ℹ️ View Unchanged
|
Visit the preview URL for this PR (updated for commit be6dd7e): https://docusaurus-openapi-36b86--pr239-yxl9r0k2.web.app (expires Thu, 06 Oct 2022 13:19:06 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
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.
Description
Introduces changes/fixes to allow users to specify a mustache template file for customizing the markdown/MDX structure for API docs. Although it's technically possible to prepend or append content to the
ApiItem
andApiDemoPanel
sections the primary use case is to customize the MDX frontmatter.Motivation and Context
Allows users to customize how the API MDX is rendered so they can do things like customize the frontmatter
custom_edit_url
and other fields.How Has This Been Tested?
Tested with Petstore API. This PR also includes a sample mustache template and usage.