TextScribe

TexTScribe - Convertisseur Markdown

Le convertisseur Markdown est un utilitaire de ligne de commande robuste construit avec de la rouille. Il est conçu pour transformer les fichiers Markdown en format HTML, EPUB et PDF sans effort. Avec la puissance de la caisse «Pulldown-Cmark», il garantit l'analyse et le rendu précis du contenu Markdown.

Table des matières

• ? Caractéristiques
• Installation
• ? Usage
  • Exemple
• ? Options
• ? Future feuille de route
• ? Contributif
• Licence

? Caractéristiques

• Conversion SWIFT : Convertissez instantanément vos fichiers de marque en HTML, PDF et EPUB.

• Interface intuitive : une interface de ligne de commande conviviale alimentée par la caisse clap .

• Rich Markdown Support : prend en charge un large éventail de syntaxes Markdown, y compris les en-têtes, les paragraphes, les listes, l'accent, les liens, les images (avec intégration Base64) et les blocs de code.

• Options de personnalisation : Choisissez des fonctionnalités de marque spécifiques telles que les tables et le strikethrough à l'aide des options pulldown-cmark .

• Sortie flexible : enregistrez le HTML ou l'EPUB généré dans un emplacement spécifié, copiez-le directement dans le presse-papiers ou prévisualisez-le dans votre navigateur Web par défaut.

• THEMING : Style votre sortie HTML avec différents thèmes.

Installation

1. Configurez Rust Environment : si vous n'avez pas installé Rust and Cargo, procurez-les sur le site officiel de Rust.

2. Clone le référentiel :

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

3. Accédez au répertoire du projet :

    cd TextScribe

4. Compiler le projet :

    cargo build --release 

? Usage

Pour convertir votre marque en HTML ou EPUB, utilisez la commande suivante:

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

• <input-file> : Chemin vers votre fichier Markdown.
• <output-file> : (facultatif) chemin pour la sortie HTML. Si ce n'est pas fourni et ni les options de presse-papiers ni de navigateur ne sont utilisées, une erreur sera invitée.
• --theme <theme-name> : Choisissez un thème (options: par défaut, sombre, lumière).
• --clipboard : Copiez le HTML généré directement dans le presse-papiers.
• --browser : prévisualisez le HTML généré dans votre navigateur Web par défaut.
• --epub : générer un fichier ePub. Parfait pour les lecteurs.

Exemple:

Convertir example.md en html en utilisant le thème sombre et l'enregistrer sous output.html :

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

Pour copier la sortie directement dans le presse-papiers:

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

Pour prévisualiser la sortie dans votre navigateur Web par défaut:

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

Convertir example.md en epub en utilisant le thème sombre et l'enregistrer sous la forme output.epub :

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

? Options

• THEMING : Style votre sortie HTML.

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

• Tables : Activez le formatage de la table dans votre marque.

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

• Strikethrough : Activer la mise en forme du strikethrough.

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

• Sortie du presse-papiers : Copiez le HTML généré dans le presse-papiers.

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

• Aperçu du navigateur : affichez le HTML généré dans votre navigateur Web par défaut.

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

? Future feuille de route

• ✅ Prise en charge de plus de types d'images : prise en charge de plus de types d'images; GIFS, PNG, JPEG.
• ✅ Amélioration de la gestion des erreurs : fonctionnalité et journalisation améliorés pour les erreurs.
• ✅ Conversion PDF : Intégrez les fonctionnalités pour convertir le HTML généré en format PDF.
• • THEMING EXTENCE : Présentez plus de thèmes et d'options de personnalisation pour la sortie HTML.
• • GUI interactive : développez une interface utilisateur graphique pour les utilisateurs qui préfèrent l'interface graphique à CLI.
• • Support d'image amélioré : améliorez l'intégration d'images avec des options de redimensionnement, d'alignement et de légendes.

Nous sommes toujours ouverts aux suggestions et aux commentaires. Si vous avez une idée qui n'est pas répertoriée ici, partagez-la avec nous!

? Contributif

Les contributions sont toujours les bienvenues! Qu'il s'agisse d'une demande de fonctionnalité, d'une correction de bogue ou d'une nouvelle idée, n'hésitez pas à soumettre une demande de traction ou à ouvrir un problème. Améliorons cet outil ensemble! Assurez-vous de lire le fichier contributif pour savoir plus de détails sur les contributions.

Licence

Ce projet est autorisé sous la licence du MIT.