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

Playground Feature: Markdown READMEs - Milestone 3 #82

Conversation

hichana
Copy link
Contributor

@hichana hichana commented Oct 27, 2021

Playground Feature: Markdown READMEs - Milestone 3

Description

This PR is for issue #18.

This PR adds support for storing and loading the README data in the frontend.
The code follows the existing design patterns used in the frontend codebase. Namely the existing router.

We tried several markdown editors and settled on react-simplemde-editor a react wrapper for the popular and well maintained easy-markdown-editor.

We chose this editor as it renders the syntax while editing to clearly show the expected result (rather than requiring a separate preview section). Headings are larger, emphasized words are italicized, links are underlined, etc. It also allows users who may be less experienced with Markdown to use familiar toolbar buttons and shortcuts.

We also added the unreset-css package to provide default browser styling to the markup (removed elsewhere in the project with reset.css)

Submission Links & Documents

Requirements Check

  • Have have you met the milestone requirements? Yes
  • Have you included tests (if applicable)? Yes
  • Have you met the contribution guidelines of the repos you have submitted code to (if applicable)? Yes

@MaxStalker
Copy link
Contributor

🎉 Milestone Achieved! 🎉

@MaxStalker MaxStalker merged commit c7d6c5c into onflow:main Nov 5, 2021
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