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 files as markdown #18

Open
QuinnWilton opened this issue Jan 25, 2021 · 3 comments
Open

Render markdown files as markdown #18

QuinnWilton opened this issue Jan 25, 2021 · 3 comments

Comments

@QuinnWilton
Copy link

Markdown files are rendered as their raw contents: https://preview.hex.pm/preview/ecto/3.5.6/README.md

Seeing the raw contents is helpful for review, but it may also be worthwhile to expose the option of switching to a preview of the rendered output. There's not currently any UI allowances for options like this, which is likely the main blocker for making progress on this feature.

@QuinnWilton QuinnWilton changed the title Suggestion: Render markdown files as markdown Render markdown files as markdown Jan 25, 2021
@supersimple
Copy link
Member

I like the idea of being able to preview the markdown files. We already have a library to handle that (earmark)

One consideration is that I would like to see the actual code whenever possible to be as transparent as possible when auditing code. One example might be a pixel image that isn't visible, but makes a call back to homebase.

I think having a UI option to preview the markdown files would be great

@wojtekmach
Copy link
Member

There are security considerations around rendering user-generated content as HTML, Earmark should be already handling that well but I'd hold off on this for a while after all.

@ericmj
Copy link
Member

ericmj commented Jan 25, 2021

I think having a UI option to preview the markdown files would be great

👍

There are security considerations around rendering user-generated content as HTML, Earmark should be already handling that well but I'd hold off on this for a while after all.

Last time I checked earmark allowed any HTML and we need to be more conservative to avoid XSS and such.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants