Markdown Notepad

Markdown Notepad is a sleek, browser-based application designed for writing and managing Markdown documents. It offers a clean, distraction-free interface with real-time preview, making it perfect for note-taking, documentation, and creative writing.

link to app: mdNotepad

Features

• Real-time Markdown Preview: See your formatted text as you type.
• Document Management: Create, edit, and delete notes with ease.
• Tagging System: Organize your notes using tags for quick retrieval.
• Export Functionality: Save your notes as Markdown files.
• Dark Theme: Easy on the eyes for long writing sessions.
• Responsive Design: Works on desktop and mobile browsers.
• Local Storage: Your notes are saved in your browser's local storage.
• Drag and Drop: Import Markdown files by dragging them into the app.
• Markdown Cheat Sheet: Quick access to Markdown syntax reference.

Getting Started

1. Clone the repository:

   git clone https://github.com/your-username/markdown-notepad.git
   

2. Open index.html in your web browser.

3. Start creating and editing your Markdown notes!

Usage

• Create a New Note: Click the "new" button in the sidebar.
• Edit a Note: Click on a note title in the sidebar to load it into the editor.
• Preview: As you type in the left pane, see the formatted output in the right pane.
• Edit Title: Click on the current note's title to rename it.
• Add Tags: Type a tag in the input field below the title and press Enter.
• Filter by Tag: Use the dropdown in the sidebar to filter notes by tag.
• Export: Click the "export" button to download your note as a Markdown file.
• Delete: Remove unwanted notes using the "delete" button.
• Markdown Guide: Access the Markdown syntax guide by clicking "md cheat sheet" in the sidebar.

Technical Details

• Built with vanilla JavaScript, HTML, and CSS.
• Uses localStorage for client-side storage of notes.
• Implements the marked library for Markdown parsing.
• Utilizes DOMPurify for sanitizing HTML output.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is open source and available under the MIT License.

Contact

If you have any questions or feedback, please open an issue on the GitHub repository.

Happy writing!