Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render markdown in description fields #153

Closed
wlach opened this issue Oct 21, 2020 · 2 comments
Closed

Render markdown in description fields #153

wlach opened this issue Oct 21, 2020 · 2 comments
Assignees

Comments

@wlach
Copy link
Contributor

wlach commented Oct 21, 2020

Currently we're now rendering markdown in Glean description fields, which doesn't look great:

image
http://localhost:5000/#!/apps/mozregression

We should render these types of fields with markdown. For the schema dictionary I used the marked parser, which seems to work pretty well: https://www.npmjs.com/package/marked

It seems most likely that we'll define a svelte component for rendering this type of information, in which case we should add a story for it in: https://github.com/mozilla/glean-dictionary/tree/main/stories

@alvesitalo
Copy link
Contributor

I sent a pr #155 fixing this @wlach.

@wlach
Copy link
Contributor Author

wlach commented Oct 23, 2020

I sent a pr #155 fixing this @wlach.

Thanks! I will have a look at it on Monday.

@wlach wlach closed this as completed in e5dd308 Oct 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants