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

ui: Markdown component #520

Open
bobjac opened this issue Oct 5, 2023 · 1 comment
Open

ui: Markdown component #520

bobjac opened this issue Oct 5, 2023 · 1 comment

Comments

@bobjac
Copy link
Contributor

bobjac commented Oct 5, 2023

Requirement

Publishers may want to include README.md files are part of their deployment so they can have free flow documentation on their solution. This readme file should be displayed as a component in the dashboard after install.

Success Criteria

  • A README.md file that is located at the root of the content.zip file should be displayed in an Component that is tabbed off the "Overview" Heading
  • MD format should be honored
    • Public links should be reachable
    • Publicly accessible images should be displayed
    • Text formatting should be consistent with MD format standard

Justification

Publishes will want to communicate with the installer of their solution. The README packaged with their content is intended to compliment the documentation configured by the publisher prior to deployment.

Implementation

  • Create a react component that has 2 visual cards using the fluent ui
  • User npm install react-markdown to use the react-markdown component to render markdown
@bobjac bobjac added this to the CY23 Q2 - Cycle 2 (2023-17-11) milestone Oct 5, 2023
@bobjac bobjac self-assigned this Oct 5, 2023
@kevinhillinger
Copy link
Member

A nice to have. Address post private preview / Q2, cycle 3

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

2 participants