docs: replace Sync/Async MkDocs tabs with GitHub-native <details> blocks#167
Merged
Merged
Conversation
Replace pymdownx.tabbed '=== "Sync"/"Async"' content-tabs (render as literal text + lose highlighting on GitHub) with <details markdown="1"> collapsible blocks in README + 16 docs pages. Add md_in_html extension so fenced code inside <details> highlights on the MkDocs site.
This file contains hidden or 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
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.
Closes #166
What
Replace Material-for-MkDocs
=== "Sync"/"Async"content-tabs with GitHub-native collapsible<details markdown="1"><summary>Sync|Async</summary>blocks in the README and 16 docs pages. Enablemd_in_htmlinmkdocs.ymlso fenced code inside<details>still highlights on the ReadTheDocs site.Why
=== "Sync"renders as literal text on GitHub and the 4-space-indented fenced code beneath it loses syntax highlighting.<details>renders correctly on both GitHub and MkDocs.Changed
<details>across README.md + 16 docs/*.md (docs/index.md is a symlink to README, so it's covered automatically -> 36 blocks total).- md_in_htmltomarkdown_extensions. Leftpymdownx.tabbedin place (removal not in scope; harmless once unused).<details>).Verification
=== "Sync"/"Async"remain.<details>havemarkdown="1", a blank line after</summary>, and a blank line before</details>(0 problems).mkdocs build --strict: not run (mkdocs not installed locally; per task, no global tooling installed).