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 #424

Merged
merged 5 commits into from May 4, 2024
Merged

Render markdown #424

merged 5 commits into from May 4, 2024

Conversation

meissadia
Copy link
Collaborator

@meissadia meissadia commented Apr 26, 2024

Closes #421

Changes

  • Adds react-markdown library
  • Successfully renders markdown from Submission's validation description
  • Renders a more comprehensive markdown test at route /markdown (must be signed-in).

How to test this PR

  1. Upload a file for 123456789TESTBANK123 that has warnings (sbl-validations-pass.csv)
  2. Visit http://localhost:8899/markdown
  3. Observe the markdown from the Validation's description is rendered as a list item

Notes

  • We would need to add a plugin to add support for advanced elements like Tables or Strikethrough, but I've followed up with the Backend team to understand which Markdown elements we should expect from the API and only basic (list, bold) are expected to be used, so we're good to go with the current basic configuration.

Screenshots

react-markdown-test

@meissadia meissadia linked an issue Apr 26, 2024 that may be closed by this pull request
1 task
Base automatically changed from 331-filing-routing_phase2-live-data to main April 30, 2024 17:44
@meissadia meissadia changed the title WIP: render markdown Render markdown May 2, 2024
@meissadia meissadia marked this pull request as ready for review May 2, 2024 23:12
Copy link
Contributor

@billhimmelsbach billhimmelsbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good @meissadia! I'm going to let @shindigira get a peek at this one before I approve: maybe just message him and make sure he's ok merging this branch into his errors and warnings work over here, either now or when it hits main: #423

Copy link
Contributor

@shindigira shindigira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this!

@meissadia meissadia merged commit 883658b into main May 4, 2024
4 checks passed
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.

[Task] Render Markdown from API in UI
3 participants