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

The second project for the "Front End Development Libraries" course provided by FreeCodeCamp.
https://github.com/captaincluster/markdown-previewer

freecodecamp freecodecamp-project front-end html javascript markdown react

Last synced: about 1 year ago
JSON representation

The second project for the "Front End Development Libraries" course provided by FreeCodeCamp.

• Host: GitHub
• URL: https://github.com/captaincluster/markdown-previewer
• Owner: CaptainCluster
• License: gpl-3.0
• Archived: true
• Created: 2024-03-08T04:37:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-13T06:25:07.000Z (over 2 years ago)
• Last Synced: 2025-02-20T12:47:09.709Z (over 1 year ago)
• Topics: freecodecamp, freecodecamp-project, front-end, html, javascript, markdown, react
• Language: JavaScript
• Homepage:
• Size: 178 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Markdown Previewer

Markdown Previewer is the second project for the *Front End Development Libraries* course that is hosted by **FreeCodeCamp**.

It utilizes the **React** JavaScript library to build the UI. Furthermore, the program uses **Marked** to parse the user 

input in the Editor component and the parsed markdown will then be displayed in the Preview component.

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

📚 Dependencies

---

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)

> [Learn more about React here!](https://react.dev/)

In order to use the project, you need to download **NodeJS** for the necessary commands.

> [Install NodeJS here](https://nodejs.org/en/)

After this, you have to install additional project dependencies, while being in the directory of the project.

This can be done by running the following command:

> `npm install`

🚀 Running the program

---

In order to start the program, all you need to do is run this command:

> `npm start`

After this, you are good to go!

🙏 Credits

---

![FreeCodeCamp](https://img.shields.io/badge/Freecodecamp-%23123.svg?&style=for-the-badge&logo=freecodecamp&logoColor=green)

This project is a part of **FreeCodeCamp** *Front End Development Libraries Course*. While some ideas have been received from

their example project and the instructions have been followed, all the components have been made by me.