NoteMark 📝

A modern, minimalist Markdown note-taking application built with Electron, React, and TypeScript. NoteMark provides a seamless writing experience with real-time preview and automatic saving.

✨ Features

• 📝 Clean and intuitive Markdown editor
• 🔄 Real-time preview as you type
• 💾 Automatic saving (autosave after 3 seconds of inactivity)
• 🎨 Beautiful dark theme interface
• 🖥️ Cross-platform support (Windows, macOS, Linux)
• 📁 Local file system storage
• ⚡ Fast and lightweight

🛠️ Built With

• Electron - Cross-platform desktop framework
• React - UI framework
• TypeScript - Type-safe JavaScript
• TailwindCSS - Utility-first CSS framework
• MDXEditor - Markdown editor component
• Jotai - Atomic state management
• electron-vite - Electron Build Tool

🚀 Getting Started

Prerequisites

• Node.js 20.x or later
• yarn or npm

Installation

• Clone the repository

git clone https://github.com/KhaledSaeed18/NoteMark.git
cd NoteMark

• Install dependencies

yarn
# or
npm install

• Start development server

yarn dev
# or
npm run dev

Building

Build for your current platform:

yarn build

Platform-specific builds:

# Windows
yarn build:win

# macOS
yarn build:mac

# Linux
yarn build:linux

📝 Currently Supported Markdown Features

• Text Formatting

  • Bold text (**bold**)
  • Italic text (_italic_)

• Headers

  • H2 (## Heading 2)
  • H3 (### Heading 3)
  • H4 (#### Heading 4)

• Lists

  • Bulleted lists
  • Numbered lists

• Blockquotes

  • Single line quotes (> quote)

• Code

  • Inline code (`code`)