elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.51k stars 8.06k forks source link

Consolidate markdown implementation in Kibana #181043

Open eokoneyo opened 3 months ago

eokoneyo commented 3 months ago

Describe the feature:

At the moment, within Kibana there exists multiple markdown implementations across the app; we have the legacy markdown component that leverages the package markdown-it which adheres to the commonmark spec then there's the markdown component provided by the shared UX team which is built on top of the Markdown component provided by EUI team which aims to adhere to the Github flavor markdown spec (referred to from here on as GfM), see https://github.com/elastic/eui/pull/5272#pullrequestreview-784790063.

There are also multiple occurrences of the direct usages of the eui markdown component too across the codebase, all of this unfortunately leads to a lack of coherence with the markdown style across the app especially that the eui markdown component, being built on top of remark (basically a text processor) allows any direct usage of the EUI markdown component the addition of any plugin of choice which could in turn further diversify the markdown styles Kibana supports.

This became very evident, with the attempt to migrate parts of the codebase to the shared UX component, we had reports of in consistencies in rendering expectations. See https://github.com/elastic/kibana/issues/180576

Proposal;

elasticmachine commented 3 months ago

Pinging @elastic/appex-sharedux (Team:SharedUX)