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

Markdown Render - Nexus Description #2258

Merged
merged 20 commits into from
Aug 12, 2024
Merged

Markdown Render - Nexus Description #2258

merged 20 commits into from
Aug 12, 2024

Conversation

Alex-Tideman
Copy link
Contributor

@Alex-Tideman Alex-Tideman commented Aug 8, 2024

Description & motivation 💭

To render Markdown in the UI, we will send the string of markdown to be processed on the /render endpoint, removing any images/html/scripts and sanitizing the content. The endpoint will return the HTML response with strict Content-Security-Policy.

To render the Markdown, we will use an iframe that uses the /render endpoint as the src. To edit the Markdown, we use the Monaco editor.

The markdown.css file has the markdown-specific styling for the elements we want to render (headings, list, blockquote, code).

Screenshots (if applicable) 📸

Screenshot 2024-08-08 at 2 08 42 PM Screenshot 2024-08-08 at 2 08 54 PM Screenshot 2024-08-08 at 2 09 04 PM Screenshot 2024-08-08 at 2 10 00 PM Screenshot 2024-08-08 at 2 10 10 PM

Design Considerations 🎨

Testing 🧪

How was this tested 👻

  • Manual testing
  • E2E tests added
  • Unit tests added

Steps for others to test: 🚶🏽‍♂️🚶🏽‍♀️

Checklists

  • Figure out how to dynamically update the height of the iframe
  • Open links in new tab

Draft Checklist

Merge Checklist

Issue(s) closed

Docs

Any docs updates needed?

@Alex-Tideman Alex-Tideman requested review from stevekinney, rossedfort and a team as code owners August 8, 2024 19:19
Copy link

vercel bot commented Aug 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
holocene ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 12, 2024 2:55pm

@Alex-Tideman Alex-Tideman requested a review from laurakwhit August 8, 2024 19:21
@Alex-Tideman Alex-Tideman merged commit d7781aa into main Aug 12, 2024
14 checks passed
@Alex-Tideman Alex-Tideman deleted the markdown-renderer branch August 12, 2024 15:44
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

Successfully merging this pull request may close these issues.

2 participants