TextScribe

STEXSCRECE - Markdown -Konverter

Der Markdown-Konverter ist ein robustes Befehlszeilendienstprogramm, das mit Rost erstellt wurde. Es wurde entwickelt, um Markdown -Dateien mühelos in HTML, EPUB & PDF -Format umzuwandeln. Mit der Kraft der Kiste "Pulldown-Cmark" gewährleistet es eine genaue Parsen und das Rendern von Markdown-Inhalten.

Inhaltsverzeichnis

• ? Merkmale
• Installation
• ? Verwendung
  • Beispiel
• ? Optionen
• ? Zukünftige Roadmap
• ? Beitragen
• Lizenz

? Merkmale

• Swift Conversion : Umwandeln Sie Ihre Markdown -Dateien sofort in HTML, PDF & EPUB.

• Intuitive Schnittstelle : Eine benutzerfreundliche Befehlszeilenschnittstelle, die von der clap Kiste betrieben wird.

• Rich Markdown -Unterstützung : Unterstützt eine breite Palette von Markdown -Syntax, einschließlich Überschriften, Absätzen, Listen, Betonung, Links, Bildern (mit Base64 -Einbettung) und Codeblöcken.

• Anpassungsoptionen : Wählen Sie mit den Optionen pulldown-cmark bestimmte Markdown-Funktionen wie Tabellen und Striikenghrough.

• Flexible Ausgabe : Speichern Sie die generierte HTML oder EPUB in einem angegebenen Ort, kopieren Sie sie direkt in die Zwischenablage oder stellen Sie sie in Ihrem Standard -Webbrowser vor.

• Theming : Style deine HTML -Ausgabe mit verschiedenen Themen.

Installation

1. Setup Rostumgebung : Wenn Sie Rost und Fracht nicht installiert haben, holen Sie sie sich von der offiziellen Website von Rust.

2. Klonen Sie das Repository :

    git clone https://github.com/arncv/TextScribe.git

3. Navigieren Sie zum Projektverzeichnis :

    cd TextScribe

4. Kompilieren Sie das Projekt :

    cargo build --release 

? Verwendung

Verwenden Sie den folgenden Befehl, um Ihren Markdown in HTML oder EPUB umzuwandeln:

 cargo run --release -- -i <input-file> [-o <output-file>] [--theme <theme-name>] [--clipboard] [--browser] [--epub]

• <input-file> : Pfad zu Ihrer Markdown-Datei.
• <output-file> : (optional) Pfad für die HTML-Ausgabe. Wenn nicht zur Verfügung gestellt und es weder die Zwischenablage noch Browseroptionen verwendet werden, wird ein Fehler aufgefordert.
• --theme <theme-name> : Wählen Sie ein Thema (Optionen: Standard, dunkel, hell).
• --clipboard : Kopieren Sie die generierte HTML direkt in die Zwischenablage.
• --browser : Vorschau des generierten HTML in Ihrem Standard-Webbrowser.
• --epub : Generieren Sie eine EPUB-Datei. Perfekt für Leser.

Beispiel:

Konvertieren Sie example.md in HTML mit dem dunklen Thema und speichern Sie es als output.html :

 cargo run --release -- -i example.md -o output.html --theme dark

So kopieren Sie die Ausgabe direkt in die Zwischenablage:

 cargo run --release -- -i example.md --clipboard

Um die Ausgabe in Ihrem Standard -Webbrowser anzunehmen:

 cargo run --release -- -i example.md --browser

Konvertieren Sie example.md in EPUB mit dem dunklen Thema und speichern Sie es als output.epub :

 cargo run --release -- -i example.md -o output.epub --theme dark --epub 

? Optionen

• Theming : Style deine HTML -Ausgabe.

   cargo run --release -- -i <input-file> -o <output-file> --theme <theme-name>

• Tabellen : Aktivieren Sie die Tabellenformatierung in Ihrem Markus.

   cargo run --release -- -i <input-file> -o <output-file> --tables

• STIKTHROUGH : Ermöglichen Sie die Formatierung von Striicken.

   cargo run --release -- -i <input-file> -o <output-file> --strikethrough

• Ausgabe von Zwischenablage : Kopieren Sie die generierte HTML in die Zwischenablage.

   cargo run --release -- -i <input-file> --clipboard

• Browser -Vorschau : Zeigen Sie den generierten HTML in Ihrem Standard -Webbrowser an.

   cargo run --release -- -i <input-file> --browser 

? Zukünftige Roadmap

• ✅ Unterstützung mehr Bildtypen : Unterstützung für weitere Bildtypen; GIFS, PNG, JPEG.
• ✅ Verbesserte Fehlerbehandlung : Verbesserte Funktionalität und Protokollierung für Fehler.
• ✅ PDF -Konvertierung : Integrieren Sie die Funktionalität, um das generierte HTML in PDF -Format umzuwandeln.
• • Erweiterte Themen : Führen Sie mehr Themen und Anpassungsoptionen für die HTML -Ausgabe ein.
• • Interaktive GUI : Entwickeln Sie eine grafische Benutzeroberfläche für Benutzer, die GUI gegenüber CLI bevorzugen.
• • Verbesserte Bildunterstützung : Verbesserung der Bildeinbettung mit Optionen zur Größe, Ausrichtung und Untertitel.

Wir sind immer offen für Vorschläge und Feedback. Wenn Sie eine Idee haben, die hier nicht aufgeführt ist, teilen Sie sie bitte mit uns!

? Beitragen

Beiträge sind immer willkommen! Unabhängig davon, ob es sich um eine Feature -Anfrage, eine Fehlerbehebung oder eine neue Idee handelt, können Sie eine Pull -Anfrage senden oder ein Problem öffnen. Lassen Sie uns dieses Tool gemeinsam verbessern! Lesen Sie unbedingt die Datei, um weitere Beiträge zu erfahren.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.