MD Reader

Ein moderner, benutzerfreundlicher Markdown Reader, entwickelt mit Electron. Die Anwendung ermöglicht das einfache Lesen und Anzeigen von Markdown-Dateien mit einer eleganten Benutzeroberfläche.

📸 Screenshots

Hauptansicht des MD Readers mit geöffnetem Markdown-Dokument

MD Reader mit geöffneten Einstellungen

🌟 Hauptfunktionen

• Intuitive Benutzeroberfläche: Moderne und übersichtliche Gestaltung für optimale Benutzerfreundlichkeit
• Automatische Integration: Nahtlose Registrierung als Standard-Anwendung für .md Dateien
• Umfassende Markdown-Unterstützung:
  • Alle Standard Markdown-Elemente
  • Tabellen
  • Code-Blöcke mit Syntax-Highlighting
  • Mathematische Formeln
  • Checklisten
• Echtzeit-Vorschau: Sofortige Darstellung der Markdown-Formatierung
• Datei-Verwaltung: Einfaches Öffnen und Navigieren zwischen Dokumenten
• Plattformübergreifend: Verfügbar für Windows, macOS und Linux

🚀 Erste Schritte

Voraussetzungen

• Node.js (Version 14 oder höher)
• npm (wird mit Node.js installiert)

Installation

1. Repository klonen:

git clone https://github.com/byKoma/MDReader.git
cd MDReader

2. Abhängigkeiten installieren:

npm install

3. Anwendung starten:

npm start

Build erstellen

Für die Erstellung einer ausführbaren Datei:

npm run build

Die kompilierte Anwendung finden Sie im dist Ordner.

💡 Verwendung

1. Erste Schritte:

   • Starten Sie die Anwendung
   • Wählen Sie "Datei öffnen" oder nutzen Sie Drag & Drop
   • Alternativ: Doppelklicken Sie eine .md Datei (nach Installation)

2. Tastenkombinationen:

   • Strg + O: Datei öffnen
   • Strg + Q: Anwendung beenden
   • Strg + +: Vergrößern
   • Strg + -: Verkleinern

🛠 Technologie-Stack

• Electron: Framework für Desktop-Anwendungen
• Marked: Markdown-Parser und Compiler
• Prism.js: Syntax-Highlighting
• HTML/CSS/JavaScript: Frontend-Entwicklung
• electron-builder: Anwendungs-Packaging

🤝 Beitragen

Beiträge sind willkommen! Bitte beachten Sie folgende Schritte:

1. Fork des Repositories
2. Feature-Branch erstellen (git checkout -b feature/AmazingFeature)
3. Änderungen committen (git commit -m 'Add some AmazingFeature')
4. Branch pushen (git push origin feature/AmazingFeature)
5. Pull Request erstellen

📝 Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert - siehe LICENSE Datei für Details.

📞 Kontakt

byKoma - GitHub

Projekt-Link: https://github.com/byKoma/MDReader

🙏 Danksagung

• Electron für das großartige Framework
• Marked für den Markdown-Parser
• Allen Mitwirkenden und Unterstützern des Projekts