Issue #660: Replace HTML entities before markdownify in docs #690
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
|
|
|
When I ran |
|
Hi @acq688, thanks for taking the time to resolve this issue! The test failure you observed is a known issue and it's totally unrelated to your change. Once the CI builds pass, we will merge this PR. |
Codecov Report
@@ Coverage Diff @@
## main #690 +/- ##
=======================================
Coverage 92.05% 92.05%
=======================================
Files 172 172
Lines 5869 5869
=======================================
Hits 5403 5403
Misses 466 466 Help us with your feedback. Take ten seconds to tell us how you rate us. |
4 tasks
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.
See Issue: (#660)
Hi -- I thought I'd take a look at #660 as a good first issue in the project. However, it ended up being more complicated than characters not being escaped correctly. 😅
I believe this is being caused by an interaction between
kramdownandmarkdownifyin Github Pages specifically because this section is a code block nested inside of a<div>which in turn is nested inside of<details>. Since the<div>in question hasmarkdown="0"set, kramdown outputs this block as HTML, with the characters ">", "<", and "&" represented as>,<and&. When it hits the markdownify, it's trying to do syntax highlighting, so it wraps the semicolon in a span and the HTML becomes malformed:This is not a pretty fix -- it turns those HTML entities back into their characters before converting the section to markdown. Based on what I tried, I think this should actually be addressed in one of those two libraries and how nested code blocks are handled, but this pr should fix your documentation if you'd like.
Category (place an
xin each of the[ ])slack_bolt.Appand/or its core componentsslack_bolt.async_app.AsyncAppand/or its core componentsslack_bolt.adapter/docsRequirements (place an
xin each[ ])Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.