https://github.com/maheshmuttintidev/live-markdown-preview

Explore a new Markdown previewer that makes editing easy. It uses React for a smooth interface and Node.js for strong features. This tool helps developers and creators work faster by showing changes right away.
https://github.com/maheshmuttintidev/live-markdown-preview

markdown-editor markdown-to-html nodejs reactjs vercel

Last synced: about 1 month ago
JSON representation

Explore a new Markdown previewer that makes editing easy. It uses React for a smooth interface and Node.js for strong features. This tool helps developers and creators work faster by showing changes right away.

• Host: GitHub
• URL: https://github.com/maheshmuttintidev/live-markdown-preview
• Owner: maheshmuttintidev
• License: mit
• Created: 2024-07-04T13:02:28.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-06T14:35:21.000Z (5 months ago)
• Last Synced: 2024-09-30T00:43:54.180Z (about 2 months ago)
• Topics: markdown-editor, markdown-to-html, nodejs, reactjs, vercel
• Language: TypeScript
• Homepage: https://live-markdown-previewer.maheshmuttintidev.in
• Size: 1.57 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Live Markdown Previewer

Explore a new Markdown previewer that makes editing easy. It uses React for a smooth interface and Node.js for strong features. This tool helps developers and creators work faster by showing changes right away.

## Run in your local environment

### Frontend

#### Setup

1. Change the directory: `cd frontend`

2. Add `.env` file and add `VITE_API_URL=http://localhost:5000` and save it

3. Install dependencies: `yarn`

4. Start the development server: `yarn dev`

5. The application will be running on `http://localhost:5173`

### Backend

#### Setup

1. Change the directory: `cd frontend`

2. Install dependencies: `yarn`

3. Start the server: `yarn start:dev`

4. The server will be running on `http://localhost:5000`

5. Run tests: `yarn test`

#### API Reference

- **API Endpoint:** `http://localhost:5000/convert-to-html`

- **Method**: `POST`

- **Request Body/Payload**

```json

{

    "markdown": "# Hello World!"

}

```

- Response

```json

{

    "html": "
Hello world
\n"

}

```


## Web App Live URL

- https://live-markdown-previewer.maheshmuttintidev.in

## Backend API URL

- https://live-markdown-api.staging.maheshmuttintidev.in/convert-to-html

## Preview

![Image](/frontend/public/banner_image.webp)

> Note: If you like it, tap on the star to this repo. Follow me on github.