https://github.com/autumnchris/markdown-previewer

A React.js app that takes given Markdown syntax and outputs a preview that updates as you type.
https://github.com/autumnchris/markdown-previewer

babel css freecodecamp javascript localstorage markdown markdown-previewer react reactjs sass scss webpack

Last synced: 2 days ago
JSON representation

A React.js app that takes given Markdown syntax and outputs a preview that updates as you type.

• Host: GitHub
• URL: https://github.com/autumnchris/markdown-previewer
• Owner: autumnchris
• Created: 2017-10-11T05:22:02.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2025-02-16T20:00:20.000Z (5 days ago)
• Last Synced: 2025-02-16T21:18:36.330Z (5 days ago)
• Topics: babel, css, freecodecamp, javascript, localstorage, markdown, markdown-previewer, react, reactjs, sass, scss, webpack
• Language: SCSS
• Homepage: https://autumnchris.github.io/markdown-previewer
• Size: 2.56 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown Previewer

A React.js app that takes given Markdown syntax and outputs a preview that updates as you type.

Inspired by the [Build a Markdown Previewer challenge](https://learn.freecodecamp.org/front-end-libraries/front-end-libraries-projects/build-a-markdown-previewer) as part of the curriculum for the [Front End Development Libraries Certification](https://www.freecodecamp.org/learn/front-end-libraries) on [freeCodeCamp](https://www.freecodecamp.org).

---

## Built With

* [React.js](https://reactjs.org)

* JavaScript

* CSS3

* HTML5

* [Sass](http://sass-lang.com)

* [Node.js](https://nodejs.org/en)

* [Webpack](https://webpack.js.org)

* [Babel](https://babeljs.io)

* [marked](https://www.npmjs.com/package/marked)

* LocalStorage

* [Normalize.css](https://necolas.github.io/normalize.css)

* [Font Awesome](https://fontawesome.com)

* [Google Fonts](https://fonts.google.com)

## Demo

View project demo at [https://autumnchris.github.io/markdown-previewer](https://autumnchris.github.io/markdown-previewer).

## Instructions

After forking and cloning, navigate to the repository in your command line and install the NPM packages:

```

npm install

```

Run the following script in your command line to run the application:

```

npm start

```

Once the server is running, go to `http://localhost:8080` in your browser.

Before committing any changes, run the following script to update your static files for production:

```

npm run build

```