Skip to content

This is a Markdown Previewer web application built with React. It allows you to enter Markdown text and see the rendered HTML output in real-time.

Notifications You must be signed in to change notification settings

Vkube/A_Markdown_Previewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Previewer

This is a Markdown Previewer web application built with React. It allows you to enter Markdown text and see the rendered HTML output in real-time.

Markdown Previewer Screenshot

Features

  • Textarea for entering Markdown text.
  • Preview area that displays the rendered HTML output.
  • Supports GitHub flavored Markdown.
  • Default text with examples of various Markdown elements.
  • Real-time updating of the preview as you type.
  • Interprets carriage returns as line breaks (bonus feature).

Technologies Used

  • React: JavaScript library for building user interfaces.
  • marked: A Markdown parsing library for converting Markdown to HTML.
  • HTML: Markup language for creating the structure of the web page.
  • CSS: Styling language for designing the appearance of the web page.
  • Bootstrap: CSS framework for responsive and mobile-first web development.

Getting Started

To run the Markdown Previewer locally, follow these steps:

  1. Clone the repository:
    git clone https://github.com/Vkube/A_Markdown_Previewer.git
  2. Navigate to the project directory:
    cd markdown-previewer
  3. Install the dependencies:
    npm install
  4. Start the development server:
    npm start
  5. Start the development server:
    npm start

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

Usage

- In the editor textarea, enter your Markdown text. You can type or paste Markdown content.
- The preview area will update in real-time to display the rendered HTML output.
- As you continue typing or making changes to the Markdown text, the preview will update accordingly.
- You can modify the default Markdown text provided in the editor to see different examples of Markdown elements.

Credits

  • React
  • marked
  • Bootstrap

License

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

About

This is a Markdown Previewer web application built with React. It allows you to enter Markdown text and see the rendered HTML output in real-time.

Resources

Stars

Watchers

Forks