📄 Type in Markdown to see your compiled Markdown text. Visit the project by clicking here.
This project is part of the Free Code Camp's Front-end Libraries Projects, and follows a series of requested user stories. You can visit the project's website and click 'Run Tests' on the FreeCodeCamp Test Suite on the top left corner to see the below tests pass.
- User Story #1: I can see a
textareaelement with a correspondingid="editor". - User Story #2: I can see an element with a corresponding
id="preview". - User Story #3: When I enter text into the
#editorelement, the#previewelement is updated as I type to display the content of the textarea. - User Story #4: When I enter GitHub flavored markdown into the
#editorelement, the text is rendered as HTML in the#previewelement as I type (HINT: You don't need to parse Markdown yourself - you can import the Marked library for this: https://cdnjs.com/libraries/marked). - User Story #5: When my markdown previewer first loads, the default text in the
#editorfield should contain valid markdown that represents at least one of each of the following elements: a header (H1 size), a sub header (H2 size), a link, inline code, a code block, a list item, a blockquote, an image, and bolded text. - User Story #6: When my markdown previewer first loads, the default markdown in the
#editorfield should be rendered as HTML in the#previewelement. - Optional Bonus (you do not need to make this test pass): My markdown previewer interprets carriage returns and renders them as
br(line break) elements.
To run the project locally, use your favorite command-line interface to type the following commands:
- Clone it with
git clone git@github.com:carolinaknoll/markdown-previewer.git - Go to the project's directory with
cd markdown-previewer - Install the required dependencies with
npm install - Finally, start the project with
npm start