TextScribe

TextScribe - Markdown Converter

Markdown Converter adalah utilitas baris perintah yang kuat yang dibangun dengan karat. Ini dirancang untuk mengubah file Markdown menjadi format HTML, EPUB & PDF dengan mudah. Dengan kekuatan peti 'pulldown-cmark', ini memastikan penguraian dan rendering konten penurunan harga yang akurat.

Daftar isi

• ? Fitur
• Instalasi
• ? Penggunaan
  • Contoh
• ? Opsi
• ? Roadmap di masa depan
• ? Berkontribusi
• Lisensi

? Fitur

• Konversi SWIFT : Langsung ubah file penurunan harga Anda menjadi HTML, PDF & EPUB.

• Antarmuka intuitif : Antarmuka baris perintah yang ramah pengguna yang ditenagai oleh peti clap .

• Dukungan Markdown yang Kaya : Mendukung berbagai sintaks penurunan harga, termasuk judul, paragraf, daftar, penekanan, tautan, gambar (dengan embedding base64), dan blok kode.

• Opsi Kustomisasi : Pilih fitur markdown spesifik seperti tabel dan strikethrough menggunakan opsi pulldown-cmark .

• Output Fleksibel : Simpan HTML atau EPUB yang dihasilkan ke lokasi yang ditentukan, salin langsung ke clipboard, atau pratinjau di browser web default Anda.

• Tema : Gaya output HTML Anda dengan tema yang berbeda.

Instalasi

1. Siapkan Lingkungan Rust : Jika Anda belum memasang karat dan kargo, dapatkan dari situs web resmi Rust.

2. Klon Repositori :

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

3. Arahkan ke Direktori Proyek :

    cd TextScribe

4. Kompilasi proyek :

    cargo build --release 

? Penggunaan

Untuk mengonversi penurunan harga Anda ke HTML atau EPUB, gunakan perintah berikut:

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

• <input-file> : Path to Markdown File Anda.
• <output-file> : (opsional) jalur untuk output HTML. Jika tidak disediakan dan opsi clipboard maupun browser tidak digunakan, kesalahan akan diminta.
• --theme <theme-name> : Pilih tema (Opsi: Default, Dark, Light).
• --clipboard : Salin HTML yang dihasilkan langsung ke clipboard.
• --browser : Pratinjau HTML yang dihasilkan di browser web default Anda.
• --epub : Hasilkan file EPUB. Sempurna untuk pembaca.

Contoh:

Convert example.md ke html menggunakan tema gelap dan simpan sebagai output.html :

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

Untuk menyalin output langsung ke clipboard:

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

Untuk melihat pratinjau output di browser web default Anda:

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

Convert example.md ke epub menggunakan tema gelap dan simpan sebagai output.epub :

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

? Opsi

• Tema : Gaya output HTML Anda.

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

• Tabel : Aktifkan pemformatan tabel dalam penurunan harga Anda.

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

• Strikethrough : Aktifkan pemformatan serangan.

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

• Output Clipboard : Salin HTML yang dihasilkan ke clipboard.

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

• Pratinjau Browser : Lihat HTML yang dihasilkan di browser web default Anda.

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

? Roadmap di masa depan

• ✅ Mendukung lebih banyak jenis gambar : Dukungan untuk lebih banyak jenis gambar; GIFS, PNG, JPEG.
• ✅ Penanganan kesalahan yang ditingkatkan : Peningkatan fungsionalitas & pencatatan untuk kesalahan.
• ✅ Konversi PDF : Mengintegrasikan fungsionalitas untuk mengubah HTML yang dihasilkan menjadi format PDF.
• • Extended Theming : Perkenalkan lebih banyak tema dan opsi kustomisasi untuk output HTML.
• • GUI Interaktif : Kembangkan antarmuka pengguna grafis untuk pengguna yang lebih suka GUI daripada CLI.
• • Dukungan gambar yang ditingkatkan : Meningkatkan embedding gambar dengan opsi untuk mengubah ukuran, penyelarasan, dan keterangan.

Kami selalu terbuka untuk saran dan umpan balik. Jika Anda memiliki ide yang tidak tercantum di sini, silakan bagikan dengan kami!

? Berkontribusi

Kontribusi selalu diterima! Baik itu permintaan fitur, perbaikan bug, atau ide baru, jangan ragu untuk mengirimkan permintaan tarik atau membuka masalah. Mari kita tingkatkan alat ini bersama -sama! Pastikan untuk membaca file yang berkontribusi untuk mengetahui tentang lebih banyak detail kontribusi.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT.