Giter VIP home page Giter VIP logo

kalutu / markdown-previewer Goto Github PK

View Code? Open in Web Editor NEW
6.0 1.0 0.0 228 KB

The Markdown Previewer is a web application that allows you to write and preview Markdown content in real-time. It uses the `marked` library to convert Markdown syntax into HTML for rendering.

Home Page: https://previewmarkdown.vercel.app

HTML 21.61% JavaScript 52.81% CSS 25.58%
reactjs marked bootstrap5 html5-css3

markdown-previewer's Introduction

Markdown Previewer

The Markdown Previewer is a web application that allows you to write and preview Markdown content in real-time. It uses the marked library to convert Markdown syntax into HTML for rendering.

Preview

Markdown Previewer Website Preview

Features

  • Live Markdown preview: As you type in the editor, the preview section updates in real-time to show the rendered Markdown content.
  • Support for Markdown syntax: The previewer supports various Markdown elements such as headers, links, code blocks, lists, blockquotes, images, and formatting (e.g., bold, italic).

Technologies Used

The Markdown Previewer is built using the following technologies:

  • React: A JavaScript library for building user interfaces.
  • marked: A library for parsing Markdown and converting it to HTML.
  • Bootstrap: A popular CSS framework for styling the application.
  • Babel: A JavaScript compiler that enables the use of the latest JavaScript features in the browser.

Getting Started

To run the Markdown Previewer locally, follow these steps:

  1. Clone the repository: git clone https://github.com/Kalutu/Markdown-Previewer
  2. Navigate to the project directory: cd markdown-previewer
  3. Install the dependencies: npm install
  4. Start the development server: npm start
  5. Open your web browser and visit http://localhost:3000 to access the Markdown Previewer.

Usage

  1. Enter your Markdown content in the editor section of the application.
  2. The preview section will update in real-time to display the rendered Markdown content.
  3. Modify the Markdown content to see the preview update dynamically.

Contributing

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

Credits

This Markdown Previewer project is part of the FreeCodeCamp Frontend Certification course. It was completed as one of the required projects in the curriculum.

FreeCodeCamp (FCC) is a nonprofit organization that offers a comprehensive web development curriculum and certifications. The Frontend Certification focuses on frontend libraries and frameworks like React, and it covers various topics including HTML, CSS, JavaScript, and more.

Learn more about FreeCodeCamp and their educational programs on their official website: https://www.freecodecamp.org/

markdown-previewer's People

Contributors

kalutu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.