Skip to content

thakuranshu-dev/markdown-note-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MARKDOWN-NOTE-EDITOR

Capture thoughts effortlessly, transform ideas into notes.


Table of Contents


Overview

markdown-note-editor is a powerful, React-based application designed for seamless markdown note-taking and management. It combines intuitive design with robust functionality, making it the perfect tool for developers and writers who want to manage their notes effortlessly.


Features

  • ✏️ Real-time Markdown Editing: Create and edit notes instantly with immediate feedback.
  • 💾 Local Storage Integration: Save your notes directly to local storage for easy access and preservation.
  • 🖥️ User-friendly Interface: Enjoy a clear separation between editing and viewing notes for enhanced usability.
  • 🎨 Responsive Design: Built with Tailwind CSS for a visually appealing experience across all devices.
  • 🔍 Linting and Best Practices: Integrated ESLint configuration ensures high code quality and maintainability.
  • Hot Module Replacement (HMR): Experience faster development with live updates without full page reloads.
  • Export/Download note: You can export/download your notes as .md or .html by double-clicking or long-pressing the note.

Built With

  • JavaScript
  • React
  • Vite
  • npm
  • ESLint
  • Tailwind CSS
  • Markdown
  • JSON

Getting Started

Prerequisites

  • Programming Language: JavaScript
  • Environment: Node.js
  • Package Manager: npm

Installation

  1. Clone the repository:

    git clone https://github.com/thakuranshu-dev/markdown-note-editor
  2. Navigate to the project directory:

    cd markdown-note-editor
  3. Install dependencies:

    npm install

Usage

To start the project locally:

npm start

Try this out at Markdown Note Editor

License

This project is unlicensed.


Capture your ideas. Organize your thoughts. Write with markdown-note-editor.

About

A Simple Markdown Note Editor With Live Preview

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published