Skip to content

Markdown Previewer: A React and Vite-powered web app for writing and previewing Markdown in real-time.

Notifications You must be signed in to change notification settings

forhadakhan/markdown-previewer

Repository files navigation

Markdown Previewer

A simple Markdown previewer built with React.

Description

The Markdown Previewer is a web application that allows users to write and preview Markdown syntax in real-time. It provides a convenient way to see how the Markdown text will be rendered as HTML.

Features

  • Live preview: The Markdown text is rendered into HTML in real-time as the user types.
  • Fullscreen mode: Users can toggle fullscreen mode for better readability.
  • Print functionality: Users can print the previewed Markdown content.

Technologies Used

  • React: JavaScript library for building user interfaces.
  • Vite: Fast and opinionated build tool for modern web applications.
  • React Showdown: React wrapper for the Showdown Markdown parser.
  • Tailwind CSS: Utility-first CSS framework for rapid UI development.

Installation

  1. Clone the repository: git clone https://github.com/forhadakhan/markdown-previewer.git
  2. Navigate to the project directory: cd markdown-previewer
  3. Install the dependencies: npm install

Usage

  1. Start the application: npm start
  2. Open the browser and visit http://localhost:3000
  3. Enter your Markdown text in the editor.
  4. The preview pane will automatically update with the rendered HTML.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.

About

Markdown Previewer: A React and Vite-powered web app for writing and previewing Markdown in real-time.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published