Implement custom code block renderers support #3320
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
vmishenev
approved these changes
Nov 8, 2023
| @@ -48,6 +48,7 @@ public class DokkaBase : DokkaPlugin() { | |||
| public val externalLocationProviderFactory: ExtensionPoint<ExternalLocationProviderFactory> by extensionPoint() | |||
| public val outputWriter: ExtensionPoint<OutputWriter> by extensionPoint() | |||
| public val htmlPreprocessors: ExtensionPoint<PageTransformer> by extensionPoint() | |||
| public val htmlCodeBlockRenderers: ExtensionPoint<HtmlCodeBlockRenderer> by extensionPoint() | |||
There was a problem hiding this comment.
Can you put KDoc here as this is an extension point for plugins?
plugins/base/src/main/kotlin/renderers/html/HtmlCodeBlockRenderer.kt
Outdated
Show resolved
Hide resolved
IgnatBeresnev
approved these changes
Nov 10, 2023
...plugin-base/src/main/kotlin/org/jetbrains/dokka/base/renderers/html/HtmlCodeBlockRenderer.kt
Outdated
Show resolved
Hide resolved
* remove `code` from HtmlCodeBlockRenderer.isApplicable * add documentation for extension * add test for multiline code with linebreaks * revert default rendering to original implementation
* split applicability for defined and undefined languages * make language nullable * improve documentation for applicability and building of content * add a lot of tests for multiple renderers combinations
|
Added documentation and divided workflows for cases with explicit language and undefined. BTW, IDEA doesn't really like nested code blocks: parameters references in KDoc after the first code block are not resolved (and so not clickable): 
But it works just fine in 
And also works on GitHub: 
P.S. writing examples for Markdown code blocks via Markdown code blocks is funny and looks really strange :) |
IgnatBeresnev
approved these changes
Nov 14, 2023
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.
Fixes #3244
Notes:
languageandcodeproperties are provided instead of fullContentCodeBlocktypeExample of usage in mermaid plugin: whyoleg/dokka-mermaid@0c0cd23