https://github.com/khaledsaeed18/notemark
📝 NoteMark - A modern, cross-platform Markdown note-taking desktop application built with Electron, React, and TypeScript featuring real-time preview and autosave.
https://github.com/khaledsaeed18/notemark
desktop-application electron-vite electronjs fs-extra jotai lodash markdown reactjs tailwindcss typescript
Last synced: 2 months ago
JSON representation
📝 NoteMark - A modern, cross-platform Markdown note-taking desktop application built with Electron, React, and TypeScript featuring real-time preview and autosave.
- Host: GitHub
- URL: https://github.com/khaledsaeed18/notemark
- Owner: KhaledSaeed18
- Created: 2025-01-25T17:18:15.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-24T18:02:39.000Z (3 months ago)
- Last Synced: 2025-03-23T19:17:22.337Z (2 months ago)
- Topics: desktop-application, electron-vite, electronjs, fs-extra, jotai, lodash, markdown, reactjs, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 3.09 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://www.electronjs.org/) - Cross-platform desktop framework
- [React](https://reactjs.org/) - UI framework
- [TypeScript](https://www.typescriptlang.org/) - Type-safe JavaScript
- [TailwindCSS](https://tailwindcss.com/) - Utility-first CSS framework
- [MDXEditor](https://mdxeditor.dev/) - Markdown editor component
- [Jotai](https://jotai.org/) - Atomic state management
- [electron-vite](https://electron-vite.org/) - Electron Build Tool
## 🚀 Getting Started
### Prerequisites
- Node.js 20.x or later
- yarn or npm
### Installation
- Clone the repository
```bash
git clone https://github.com/KhaledSaeed18/NoteMark.git
cd NoteMark
```
- Install dependencies
```bash
yarn
# or
npm install
```
- Start development server
```bash
yarn dev
# or
npm run dev
```
### Building
Build for your current platform:
```bash
yarn build
```
Platform-specific builds:
```bash
# 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` ``)