PostHog / posthog

🦔 PostHog provides open-source web & product analytics, session recording, feature flagging and A/B testing that you can self-host. Get started - free.
https://posthog.com
Other
21.81k stars 1.3k forks source link

Enable markdown support for annotations #9592

Open clarkus opened 2 years ago

clarkus commented 2 years ago

Is your feature request related to a problem?

Annotations are a powerful tool for adding historical, qualitative commentary on an event history. However, some content can be better communicated with some structure or simple emphasis formatting.

Describe the solution you'd like

Introduce markdown support for annotations. I'm not sure we need to support the full range of semantic options, but generally anything that allows a user to structure text to be more readable is a good change. For example, lists, simple emphasis (bold, italics, underline, etc), quotes, etc. We should consider how the supported formatting options impact the size requirements of the annotations feature.

Describe alternatives you've considered

None at this time

Additional context

Thank you for your feature request – we love each and every one!

clarkus commented 2 years ago

Concept markdown-enabled textarea from our project home page concepts. The same component could be used to preview markdown in an annotation.

Content block - easy way to give users some control over the page

rcmarron commented 2 years ago

I love this idea and generally think we should do it. There are a ton of pretty straight forward markdown renderers that we can use. We just have to set the styles appropriately.

The one potential "gotcha" that I've hit with markdown in products is that it makes text truncation much harder. Any kind of ellipsis or "show more" links on text blocks become really difficult to implement. Besides that, I think we should markdown all the things

olegdater commented 9 months ago

very much needed :)