Git Product home page Git Product logo

markdown-previewer's Introduction

Markdown Previewer

Netlify Status

"Build a Markdown Previewer" project is part of the Front End Libraries Projects from freeCodeCamp.

Objective

  1. Build a CodePen app that is functionally similar to this.
  2. To complete this project I've decided to use React.

User Stories

  1. There should be a textarea element with a corresponding id="editor".
  2. There should be an element with a corresponding id="preview".
  3. When I enter text into the #editor element, the #preview element is updated as I type to display the content of the textarea.
  4. When I enter GitHub flavored markdown into the #editor element, the text is rendered as HTML in the #preview element 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).
  5. When my markdown previewer first loads, the default text in the #editor field 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.
  6. When my markdown previewer first loads, the default markdown in the #editor field should be rendered as HTML in the #preview element.

Testing

In order to test the requirements I've use this CDN link provided by freeCodeCamp.

How To Use It

Installation

  1. Clone the repository: https://github.com/alexandracaulea/markdown-previewer.
  2. Go to the project: cd markdown-previewer.
  3. Install project dependencies by running: yarn install.
  4. To run the project: yarn start.

Using this repository

  1. For the development run: yarn start.
  2. To build run yarn build.
  3. To run tests: yarn test.
  4. To build: yarn build.
  5. To eject yarn eject.

Live Example

Live example on Netlify

markdown-previewer's People

Contributors

alexandracaulea avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

markdown-previewer's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.