hcengineering / hcengineering/platform

Feature request: add callout notice support in the Text Editor

Open
#7,143 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
27.7k
Forks
2.2k
PR merge metrics
No merged PRs in 30d

Description

Hello,

I'd like to suggest adding support for callout notices in the text editor. This feature would allow users to add visually distinct sections for key points like tips, warnings, and important notes. Having callout notices could make documentation easier to follow and help highlight critical information, as shown in the attached example.
![chrome_lYzd8RIxN6](https://github.com/user-attachments/assets/f73754b1-778d-4866-811c-17434c9e9ec1)

Why this could be useful:
- Improved readability: With callout notices, readers can quickly identify essential points without scanning large amounts of text.
- Content organization: Callouts would make it easier to structure documents and separate different types of information in a clear and consistent way.
- Enhanced user experience: Many popular documentation tools support callouts, and adding them here could improve the overall experience.

Alternatively, it could be helpful to have support for admonitions, as shown in the attached image.

large_custom_admonitions_example_c81bf9dac8

Either option would work well—whatever fits best with your vision!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Text Editor entry point and reviewing how existing content blocks or formatting are represented. Define whether the feature should support callouts, admonitions, or both, including their types and rendered appearance; done means a documented, consistent behavior is agreed and demonstrated in the editor.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.