Markdown previewer

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Markdown previewer

Markdown previewer is a simple project that aims to clone FreeCodeCamp's version. To do this, I have built a page using React (Vite) and copied the CSS to get the same look. To get the logic done I've used the "marked" library.

🛠 Built With

Tech Stack

libraries

• React.js
• Vite
• Marked

Languages

• CSS
• Javascript
• HTML

Key Features

• Textarea where you can input text
• Preview section that outputs the marked down text

(back to top)

🚀 Live Demo

visit this link for a live demo!

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need a browser.

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone [email protected]:myaccount/my-project.git

Install

Install this project with:

Example command:

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, click on the hamburger button and select "Markdown previewer" (note: these are the tests that FreeCodeCamp include.).

👥 Authors

👤 Tomás Esquivel

• GitHub: @tomasesquivelgc

(back to top)

🔭 Future Features

• [] Expand and minimize button on topBar

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and my friends and family for their support.

(back to top)

📝 License

This project is MIT licensed.

(back to top)