https://github.com/ayyush08/markdown-preview

This is a simple React application that provides a live preview of Markdown syntax. Users can type Markdown text in a textarea, and the formatted result is displayed in real-time.
https://github.com/ayyush08/markdown-preview

Last synced: about 1 month ago
JSON representation

This is a simple React application that provides a live preview of Markdown syntax. Users can type Markdown text in a textarea, and the formatted result is displayed in real-time.

• Host: GitHub
• URL: https://github.com/ayyush08/markdown-preview
• Owner: ayyush08
• Created: 2024-06-03T17:29:49.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-03T17:42:14.000Z (8 months ago)
• Last Synced: 2024-06-03T20:31:43.758Z (8 months ago)
• Language: CSS
• Size: 65.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown Preview App

This is a simple Markdown Preview application built using Vite and React. It allows users to type Markdown text in a textarea and see the rendered HTML in real-time.

## Features

- **Live Preview**: As you type Markdown text in the input area, the preview area shows the rendered HTML.

- **User-Friendly Interface**: The application is designed with a clean and simple interface for ease of use.

- **ReactMarkdown**: Utilizes the `ReactMarkdown` library for parsing and rendering Markdown text.

## Installation and Setup

Follow these steps to get the application up and running on your local machine:

1. **Clone the repository**:

    ```bash

    git clone https://github.com/ayyush08/MarkDown-Preview.git

    cd MarkDown-Preview

    ```

2. **Install dependencies**:

    ```bash

    npm install

    ```

3. **Start the development server**:

    ```bash

    npm run dev

    ```

4. Open your browser and go to `http://localhost:5173` to see the application in action.

## Dependencies

- **react** : A JavaScript library for building user interfaces.

- **react-dom** : Serves as the entry point to the DOM and server renderers for React.

- **react-markdown** : A React component for rendering Markdown.

- **vite** : A fast build tool for modern web projects, used for serving and building the application.

## Contributions

Any sorts of contributions or suggestions are most welcome.