bond7010 / markdown-previewer-new

Markdown Previewer

Markdown Previewer is a simple web application built with React and TypeScript that allows you to write and preview Markdown content in real-time.

Features

• Real-time Markdown rendering.
• Edit and preview Markdown content side by side.
• Supports common Markdown features like headers, lists, links, and code blocks.
• Resolves the OPTIONAL BONUS in the FCC course, rendering the
  elements by importing {marked} from "https://esm.sh/marked"

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js: Make sure you have Node.js installed on your machine.

Installation

Follow these steps to get the project up and running:

1. Clone the repository:

   git clone https://github.com/Bond7010/Markdown-previewer

2. Navigate to the project folder:

   cd Markdown-Previewer/markdown-previewer

3. Install dependencies:

   npm install

Usage

1. Start the development server:

   npm start

2. Open your web browser and visit http://localhost:3000 to use the Markdown Previewer.

3. Edit the Markdown content in the left panel, and the preview will update in real-time on the right panel.

Deployment

To deploy this project to a hosting platform (e.g., GitHub Pages, Netlify, Vercel), follow the deployment instructions for your chosen platform.

Built With

• React - JavaScript library for building user interfaces.
• TypeScript - Typed superset of JavaScript.
• Markdown - Markdown model
• [Other dependencies, if applicable]

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License. See LICENSE.md for details.

Acknowledgments

• Markdown - The Markdown syntax and format.

Contact

• Your Name - [email protected]
• Project Link: https://github.com/Bond7010/Markdown-previewer