Add md interpolator to create Markdown based docs
#2452
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
987Nabil
requested review from
amitksingh1490,
jdegoes,
vigoo and
adamgfraser
as code owners
987Nabil
force-pushed
the
doc-string-interpolator
branch
from
7adf001 to
7cf2ccb
Compare
Codecov ReportPatch coverage:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #2452 +/- ##
==========================================
- Coverage 64.21% 64.13% -0.09%
==========================================
Files 136 137 +1
Lines 7118 7135 +17
Branches 1302 1228 -74
==========================================
+ Hits 4571 4576 +5
- Misses 2547 2559 +12
☔ View full report in Codecov by Sentry. |
987Nabil
force-pushed
the
doc-string-interpolator
branch
from
7cf2ccb to
aa008bf
Compare
Also distinguish between inline code and code block docs
987Nabil
force-pushed
the
doc-string-interpolator
branch
from
aa008bf to
0e3b1c2
Compare
jdegoes
approved these changes
Oct 10, 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.
Also distinguish between inline code and code block docs
The interpolator is currently not parsing, but is just dump and saves the input as "raw".
Trying to print it as plain text or html would currently fail.
Writing a markdown to Doc parser seemed to be too complex for now.
Maybe we could use
RichTextCodecto impl. this later for all 3 formats (plain, commonmark, html)?I worked together with someone from the intellij scala plugin at the ScalaDays.
He added default support for syntax highlighting of string interpolators named
md.So with the next release of the Scala plugin, md strings will have highlighting. But it can be activated manually already in the scala plugin settings.
fixes #2202
/claim #2202