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

API Directory preview card texts does not render markdown #1059

Open
rustyjux opened this issue Jun 4, 2024 · 0 comments
Open

API Directory preview card texts does not render markdown #1059

rustyjux opened this issue Jun 4, 2024 · 0 comments
Labels
enhancement New feature or request jira

Comments

@rustyjux
Copy link
Contributor

rustyjux commented Jun 4, 2024

API Services Portal Issue

User Story

As a API directory user (consumer or provider),

I want markdown rendering in API preview cards

so that I can see the intended info from the API provider.

Test Case

TESTCASE

  • Create and publish draft dataset which includes a markdown link in the first words
  • View API directory

EXPECTED

Either:

  • Markdown is rendered as rich HTML (ie with formatting, links) in the preview card

OR

  • Markdown is simplified to plain text

ACTUAL

  • Markdown shows as plain text
    image

Notes

Alternatively (or along side the solutions presented above), a short-description field as part of the dataset schema might help. The issue is this does not exist in the BCDC schema, so is not compatible for BCDC-linked records.

@rustyjux rustyjux added enhancement New feature or request jira labels Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request jira
Projects
None yet
Development

No branches or pull requests

1 participant