Skip to content

Harshilmalhotra/Markdown-Previewer

Repository files navigation

Markdown Previewer

Markdown Previewer is a simple web application that allows users to easily convert Markdown text into HTML. This tool provides a live preview of the rendered HTML as you type, making it incredibly useful for writing and previewing markdown documents on the fly.

Features

  • Live Preview : Instantly see what your markdown will look like in HTML.
  • Responsive Design : Works on both desktop and mobile devices.
  • Easy to Use : Simple, intuitive interface.

Screenshots

Screenshot_30-3-2024_174123_markdown-previewer-inky-theta vercel app Screenshot_30-3-2024_1802_markdown-previewer-inky-theta vercel app

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 12.0.0 or later)

Installation

  1. Clone the repository to your local machine:
git clone https://github.com/harshilmalhotra/markdown-previewer.git
  1. Navigate into the project directory:
cd markdown-previewer
  1. Install the necessary packages:
npm install
  1. Run the development server:
npm start
# OR 
npm run dev
# OR
yarn dev

Usage

To use the Markdown Previewer, simply start typing or pasting your markdown into the left-hand text area of the application. The right-hand side will automatically update to display the rendered HTML output of your markdown.

Built With

  • React - The web framework used
  • Marked - A markdown parser and compiler

Contributing

Any contributions you make are greatly appreciated .