Repository navigation
fix(markdown):render common prose as written - #58
Merged
Merged
Conversation
- Keep a trailing hash that belongs to a word in headings (C#, F#). - Keep underscores in titles, outline and search; anchors unchanged. - Treat prices such as $5 and $10 as prose (Pandoc math delimiters). - Leave spaced asterisks literal instead of italicising. - Allow balanced parentheses in link and image targets. - Render fenced code indented under list items inside the item. - Support ~~~ fences; close a block only on its opening marker. - Share the renderer's code lines and link grammar with audit. - Use an empty description when project.description is null. - Print an unchanged preview rebuild failure once; keep retrying.
5 tasks done
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.
Common Markdown in real READMEs and docs rendered incorrectly without any error. This makes it render as written, and fixes two small CLI/config bugs.
Rendering
## Learn C#keeps its#(a closing hash run now needs a space before it).snake_case). Anchors are unchanged, so existing#fragmentlinks keep working. GitHub-style anchors would be a 2.0 change.$5 and $10stays prose: inline math follows Pandoc's delimiter rule.2 * 3 * 4stays literal: emphasis delimiters must touch their text.~~~fences are supported; a block closes only on its opening marker.Other fixes
project.description: nullno longer produces a "None" meta description.serveprints an unchanged rebuild failure once instead of every poll. The automatic retry from v1.1.9 is kept.auditnow reuses the renderer's fenced-code lines and link grammar instead of its own copies, so the two can't drift apart.Reviewer notes
test_straight_quote_in_image_target_is_escaped. The escaping assertions still hold; only the old truncation ofalert(1)at the first)changed.> [!CAUTION]still stops the build, as documented.docs/markdown-showcase.mdexplains each rule and uses a~~~block instead of the one-space-indent workaround. CHANGELOG "Unreleased" has an entry for each fix.Checklist
python -m unittest discover -s tests(348 tests, run withPYTHONPATH=src)docsprout checkanddocsprout audit(0 errors, 0 warnings)CHANGELOG.md,docs/versions.jsonand workflow pins updated together (not a release)