Suggest Edits markup appears in rendered text

Open
#619 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
react, typescript
Domain
frontend

Research direction

Start by reviewing PR #620, which the issue identifies as the proposed work, and compare its handling of Notion Suggest Edits content with the rendered output described here. Done means the suggestion markup no longer appears in rendered text while the intended content remains readable.

Written by the indexing model from the issue text.

Description

Description:
With Notion’s recent release of the "Suggest Edits" feature—where a user can highlight a piece of text and suggest an edit—the rendered output in react-notion-x now displays suggestion markup as part of the text. I believe that this markup should be hidden or handled differently so that only the intended text is visible.

Steps to Reproduce:

  • Create or update a Notion page using the "Suggest Edits" feature (highlight text and suggest an edit).
  • Observe that the suggestion edits markup is visible in the text output.

Expected Behavior:
The suggestion markup should not be visible in the rendered text. It should either be filtered out or rendered in a way that does not interfere with the readability of the content.

Possible Solutions:
Detect and remove the suggestion edits markup from the rendered output.

I’m happy to help work on a PR to address this issue

PR here: https://github.com/NotionX/react-notion-x/pull/620

Dominant language
TypeScript
Stars
5.4k
Forks
645
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NotionX/react-notion-x

All issues in NotionX/react-notion-x

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.