Skip to content

Kalyan-Deva/react-markdown-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React Markdown Editor

A simple and user-friendly Markdown editor built with React.

Features

  • Real-time Markdown preview
  • Markdown syntax highlighting
  • Save and load your Markdown content
  • Customize the editor with themes
  • Full-screen mode
  • Keyboard shortcuts for common Markdown actions
  • Export Markdown as HTML or PDF
  • Responsive design for mobile and desktop

Installation

To run the React Markdown Editor on your local machine, follow these steps:

  1. Clone this repository:

    git clone 
  2. Change to the project directory:

    cd react-markdown-editor
  3. Install the required dependencies:

    npm install
  4. Start the development server:

    npm start
  5. Open your web browser and go to http://localhost:3000 to use the Markdown editor.

Usage

  • Type or paste your Markdown content into the editor on the left.
  • The live preview on the right will automatically update as you make changes.
  • Use the toolbar above the editor to format your Markdown text.
  • You can save your work and load it later by clicking the save and load buttons.
  • Customize the editor's theme from the settings menu.
  • Toggle full-screen mode by pressing F11 or using the full-screen button.

Keyboard Shortcuts

  • Ctrl + B or Cmd + B: Bold text
  • Ctrl + I or Cmd + I: Italicize text
  • Ctrl + U or Cmd + U: Underline text
  • Ctrl + L or Cmd + L: Create a link
  • Ctrl + Z or Cmd + Z: Undo
  • Ctrl + Shift + Z or Cmd + Shift + Z: Redo

Exporting

You can export your Markdown content as:

  • HTML: Click the "Export as HTML" button to download the HTML version of your content.
  • PDF: Click the "Export as PDF" button to generate and download a PDF document.

Contributing

If you would like to contribute to this project, please follow these steps:

  1. Fork this repository.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature-name
  3. Make your changes and commit them:

    git commit -m "Add new feature" -m "Description of your changes."
  4. Push your changes to your fork:

    git push origin feature-name
  5. Open a pull request on the original repository, describing your changes and why they should be merged.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.


You can customize this template with specific details about your "React Markdown Editor" project, including installation instructions, usage guidelines, keyboard shortcuts, and more. Additionally, replace the placeholder URLs and names with actual project information and links.

About

React Markdown Editor A simple and user-friendly Markdown editor built with React.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published