Skip to content

Ferdousfrd/markdown-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

Markdown Notes

A simple and intuitive Markdown editor that allows users to create, edit, and manage their notes. Built with React, this application provides a seamless experience for users to write and preview Markdown content in real-time.

Features

  • Create, edit, and delete notes.
  • Real-time Markdown preview and converter.
  • User-friendly interface with split view for editing and previewing.
  • Store notes with firebase clour storage.

Technologies Used

  • React: A JavaScript library for building user interfaces.
  • React-MDE: A Markdown editor for React.
  • Showdown: A Markdown to HTML converter.
  • Vite: A fast build tool that provides a great development experience.
  • Firebase: Cloud storage for the notes storage.

Getting Started

Prerequisites

Make sure you have Node.js installed on your machine.

Installation

  1. Clone the repository:
    git clone https://github.com/yourusername/notes-markdown.git
    cd notes-markdown
    
  2. Install dependencies:
    npm install
    
  3. Start the dev server:
    npm run dev
    
  4. Open your browser and navigate to http://localhost:3000 to see the app in action.

Usage

  • Click on "Create a new note" to start writing.
  • Use the split view to see the Markdown content on one side and the preview on the other.
  • Save notes locally, and they will persist even after refreshing the page.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any bugs or features you would like to see.

About

Working on a pre-built notes app with bugs low features. Fixing bugs and implementing new features.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published