Skip to content

This is a Markdown editor built using React, allowing users to create, edit, and preview Markdown documents in a user-friendly interface.

Notifications You must be signed in to change notification settings

mechXsteam/Markdown-Editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Editor

This is a Markdown editor built using React, allowing users to create, edit, and preview Markdown documents in a user-friendly interface. Markdown is a lightweight markup language that enables easy formatting of text with simple syntax.

Working

Working [1/2] Working [2/2]
working 1/2 working 2/2

Features

  • Real-time Preview: The editor provides a live preview of the rendered Markdown as you type, allowing you to see the formatted output instantly.
  • Syntax Highlighting: The editor supports syntax highlighting, making it easier to distinguish different elements and structures in the Markdown document.
  • Toolbar and Shortcuts: It offers a toolbar with commonly used formatting options, such as headings, bold, italic, lists, links, and more. Additionally, keyboard shortcuts are available for quick formatting.
  • Auto-saving: The editor automatically saves your work in progress, ensuring that you don't lose your content even if you accidentally close the application or refresh the page.
  • Responsive Design: The editor is built with a responsive design, ensuring optimal viewing and editing experience across different devices, including desktops, tablets, and mobile phones.

Technologies used

  • React.js
  • Firebase
  • Javascript
  • Vercel (deployment)

Installation

  1. Clone this repository to your local machine.
  2. Install the required dependencies by running npm install in your terminal.
  3. Start the development server with npm start.
  4. Open your browser and visit http://localhost:3000 to access the Markdown editor.

Acknowledgements

Special thanks to Bob Ziroll for his outstanding teaching in the Learn React course on Scrimba. His clear explanations, practical examples, and hands-on projects were instrumental in helping me understand and build this Markdown editor.

About

This is a Markdown editor built using React, allowing users to create, edit, and preview Markdown documents in a user-friendly interface.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published