Add optional markdownGenerators config option
#567
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
jgarrow
changed the title
markdownGenerators config option
|
Visit the preview URL for this PR (updated for commit 6145daf): https://docusaurus-openapi-36b86--pr567-gu6e56v7.web.app (expires Sat, 03 Jun 2023 23:31:18 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
blindaa121
added
documentation
blindaa121
approved these changes
May 5, 2023
There was a problem hiding this comment.
Thanks for opening up this PR @jgarrow! I think this is a great option to provide users with more flexibility in customizing MD layouts. 🎉
|
🎉 Congrats on getting your first pull request merged! We here at Palo Alto Networks are so grateful! ❤️ |
Merged
blindaa121
pushed a commit
that referenced
this pull request
Nov 13, 2023
sserrata
added a commit
that referenced
this pull request
Nov 13, 2023
* prepare release v2.0.0 * update docs * update compatibility matrix * Update announcement banner * Cherry-pick markdown generator changes #567 from v1 --------- Co-authored-by: Bryan <[email protected]>
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
This PR adds an optional
markdownGeneratorsconfig option to thedocusaurus-plugin-openapi-docsplugin, allowing the user to optionally provide their owncreateApiPageMD,createInfoPageMD, orcreateTagPageMDfunctions. If not provided, the plugin defaults to the existing functions of the same name.Motivation and Context
This change allows for a high level of customization for layout and styling. While the
templateconfig option exists, it doesn't allow for large layout changes since themarkdownavailable for the template is already generated by thecreateApiPageMD,createInfoPageMD, andcreateTagPageMDfunctions.How Has This Been Tested?
I installed a fresh Docusaurus site with this update, passing in the different config options for
markdownGeneratorsthat return strings with different content or layouts than the defaults. Excluding any of these options successfully falls back to the original behavior.Types of changes
Checklist