Repository navigation
feat: add text color and highlight marks - #84
Merged
Merged
Conversation
Adds textStyle and highlight ProseMirror marks (node builders in
substack/nodes.py), with Markdown round-trip via Pandoc-style span
attributes: [text]{style="color:#hex"} and
[text]{style="background-color:#hex"}, combinable in one span.
Verified against Substack's real editor schema by applying both marks
to a live draft and reading the rendered HTML back: textStyle becomes
a <span data-color> with inline color, highlight becomes a <mark
data-color> with inline background-color.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
Summary
Adds
textStyleandhighlightProseMirror marks for text color and highlight, since Substack's editor supports both but the library had no way to produce them.substack/nodes.py:text_style_mark(color),highlight_mark(color).[text]{style="color:#hex"}and[text]{style="background-color:#hex"}, combinable in one span ({style="color:#fff; background-color:#000"}). Restricted to spans only (not after images/links/code), so a stray{...}elsewhere stays plain text.styledeclarations are ignored rather than rejected, since the same[text]{...}syntax is used by theattrsplugin for other attributes too.Why this mark shape
I didn't want to guess the schema, so I checked it against a real Substack draft: applied both marks via the API directly, published, and read the rendered HTML back from the public post endpoint.
textStylerenders as<span data-color="#hex" style="color: rgb(...)">, confirming it's a standard TiptapTextStyle-family mark (same pattern Substack already uses for existing colored text, which I found in an export).highlightrenders as<mark data-color="#hex" style="background-color: rgb(...); color: rgb(...)">(Substack also auto-picks a readable text color for contrast) — this one wasn't previously confirmed anywhere, so I verified it the same way before writing any code against it.You can see both live, on the actual draft used to verify them: https://und1sk0.substack.com/p/ai-bullshittery
Test plan
test_from_markdown_features.py) and export/round-trip (test_markdown_export.py), including combined color+highlight and malformed-mark-as-opaque-node cases.poetry run pytest -q -m "not live" --strict-markers(278 passed).pre-commit run --all-filesclean.docs/markdown.md,README.md, andCHANGELOG.mdper CONTRIBUTING.md.🤖 Generated with Claude Code