Skip to content

iamkeeler/MarkTo-SourceCode

Repository files navigation

MarkTo

MarkTo Icon

A lightweight, native macOS application for converting Markdown to Rich Text Format (RTF)

macOS Swift License GitHub Release Contributions Welcome

About MarkTo

MarkTo is designed for users who frequently work with Markdown and need a quick, reliable way to convert it to Rich Text Format (RTF). Whether you're preparing content for applications that don't support Markdown or need to maintain formatting when copying text, MarkTo provides a seamless, native macOS experience.

✨ Features

Core Functionality

  • Instant Conversion: Convert Markdown to RTF with a single click or keyboard shortcut (⌘R)
  • Clipboard Integration: Automatically copies converted RTF to clipboard for immediate use
  • Real-time Preview: See your formatting as you type with syntax highlighting
  • Menu Bar Access: Quick access from menu bar without cluttering your dock

📝 Markdown Support

  • Headers: All levels (# H1 through #### H4)
  • Text Formatting: Bold (**text**), Italic (*text*), Inline Code (`code`)
  • Lists: Unordered (-, *, +) and ordered (1., 2., etc.)
  • Code Blocks: Fenced code blocks with ``` syntax
  • Paragraphs: Proper paragraph spacing and formatting

⚙️ Customization

  • Rich Text Formatting: Customize fonts, sizes, and styles for each Markdown element
  • Font Size Control: Adjustable editor font size (10-24pt)
  • Character Count: Optional character counter
  • Dual Interface: Choose between menu bar dropdown or standalone window

🎨 User Experience

  • Native macOS Design: Follows macOS Human Interface Guidelines
  • Accessibility: Full VoiceOver support and keyboard navigation
  • Performance: Lightning-fast conversion (< 50ms for typical documents)
  • Memory Efficient: < 8MB footprint, < 0.1% CPU when idle

🔒 Privacy

MarkTo is built with privacy as a core principle:

  • No Network Access: All processing happens locally on your Mac
  • No Data Collection: We don't collect, store, or transmit any of your data
  • No Analytics: No tracking, telemetry, or usage analytics
  • Open Source: Code is publicly available for review and transparency

Your Markdown content never leaves your device. MarkTo only accesses:

  • Clipboard: To copy converted RTF (with your explicit action)
  • User Preferences: To save your settings locally

📱 App Store

Coming Soon to the Mac App Store

🗺 Roadmap

Current Version (1.0.1)

  • ✅ Core Markdown to RTF conversion
  • ✅ Menu bar integration
  • ✅ Customizable formatting
  • ✅ Privacy-focused design

Planned Features

  • 🔄 Export to additional formats (HTML, PDF, Word)
  • 📊 Enhanced Markdown syntax support (tables, footnotes)

🚀 Usage

Quick Start

  1. Launch MarkTo from Applications or menu bar
  2. Type or paste your Markdown content
  3. Click "Convert to RTF & Copy" or press ⌘R
  4. Paste into any RTF-compatible application (Pages, Word, etc.)

Menu Bar Mode

  • Click the MarkTo icon in your menu bar for quick access
  • Right-click for settings and preferences
  • Perfect for quick conversions without opening a full window

Formatting Customization

  • Access SettingsRich Text Formatting
  • Customize fonts, sizes, and styles for each Markdown element
  • Preview changes in real-time

🏗 Architecture

MarkTo follows modern iOS/macOS development best practices:

  • MVVM Pattern: Clean separation between UI and business logic
  • SwiftUI: Native, declarative user interface
  • Combine Framework: Reactive programming for smooth performance
  • AppKit Integration: Native macOS menu bar functionality
  • Accessibility First: Built-in support for VoiceOver and assistive technologies

📊 Performance

  • Conversion Speed: < 50ms for typical documents
  • Memory Usage: < 8MB footprint
  • CPU Usage: < 0.1% when idle
  • Battery Impact: Minimal - designed for all-day use

🔧 Building from Source

Prerequisites

  • macOS 13.0 or later
  • Xcode 15.0 or later
  • Swift 5.9 or later

Build Instructions

# Clone the repository
git clone https://github.com/iamkeeler/MarkTo-SourceCode.git
cd MarkTo-SourceCode

# Open in Xcode
open MarkTo.xcodeproj

# Build and run (⌘R in Xcode)
# Or from command line:
xcodebuild -project MarkTo.xcodeproj -scheme MarkTo -configuration Release build

🤝 Contributing

We welcome contributions! MarkTo is open source and we'd love your help making it better.

Please read our Contributing Guide for detailed information about the development process, code style, and how to submit pull requests.

Quick Start for Contributors

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

Types of Contributions

  • 🐛 Bug fixes
  • ✨ New features
  • 📚 Documentation improvements
  • 🎨 UI/UX enhancements
  • 🧪 Tests
  • 🌐 Internationalization

Developer Contact

📄 License

MarkTo is released under the Creative Commons Attribution-NonCommercial 4.0 International License. See LICENSE for details.

This means you are free to:

  • Use the software for personal and non-commercial purposes
  • Modify and adapt the code for your needs
  • Share the software and your modifications
  • Sell or use commercially without permission

For commercial licensing, please contact [email protected].

This project welcomes contributions from the community!

About

A simple markdown window with RTF export

Resources

Contributing

Stars

Watchers

Forks

Packages

No packages published