Playground Feature: Markdown READMEs - Milestone 3 #82
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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