TextScribe

TextScribe-降價轉換器

降價轉換器是用Rust構建的強大命令行實用程序。它旨在輕鬆地將Markdown文件轉換為HTML，EPUB和PDF格式。借助“ plldown-cmark”板條箱的功能，它確保了降價內容的準確解析和渲染。

目錄

• ？特徵
• 安裝
• ？用法
  • 例子
• ？選項
• ？未來的路線圖
• ？貢獻
• 執照

？特徵

• 快速轉換：立即將您的Markdown文件轉換為HTML，PDF和EPUB。

• 直觀接口：由clap箱供電的用戶友好的命令行界面。

• Rich Markdown支持：支持廣泛的Markdown語法，包括標題，段落，列表，重點，鏈接，圖像（帶有基本64嵌入）和代碼塊。

• 自定義選項：使用pulldown-cmark選項選擇特定的標記功能，例如表和罷工。

• 靈活輸出：將生成的HTML或EPUB保存到指定的位置，將其直接複製到剪貼板，或在默認的Web瀏覽器中預覽。

• 主題：以不同的主題為您的HTML輸出樣式。

安裝

1. 設置Rust環境：如果您還沒有安裝Rust和Cargo，請從Rust的官方網站上獲取它們。

2. 克隆存儲庫：

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

3. 導航到項目目錄：

    cd TextScribe

4. 編譯項目：

    cargo build --release 

？用法

要將您的標記轉換為HTML或EPUB，請使用以下命令：

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

• <input-file> ：通往Markdown文件的路徑。
• <output-file> ：（可選）HTML輸出的路徑。如果未提供，既不使用剪貼板和瀏覽器選項，則會提示錯誤。
• --theme <theme-name> ：選擇一個主題（選項：默認，深色，光）。
• --clipboard ：將生成的HTML直接複製到剪貼板。
• --browser ：預覽默認Web瀏覽器中生成的HTML。
• --epub ：生成一個EPUB文件。非常適合讀者。

例子：

使用深色主題將example.md轉換為html，然後將其另存為output.html ：

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

將輸出直接複製到剪貼板：

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

要在默認Web瀏覽器中預覽輸出：

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

使用深色主題將example.md轉換為epub，並將其另存為output.epub ：

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

？選項

• 主題：樣式的HTML輸出。

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

• 表：啟用表格格式。

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

• 罷工：啟用罷工格式。

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

• 剪貼板輸出：將生成的HTML複製到剪貼板。

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

• 瀏覽器預覽：查看默認Web瀏覽器中生成的HTML。

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

？未來的路線圖

• ✅支持更多圖像類型：支持更多圖像類型； GIFS，PNG，JPEG。
• ✅改進的錯誤處理：改善了錯誤的功能和日誌記錄。
• ✅PDF轉換：集成功能以將生成的HTML轉換為PDF格式。
• • 擴展主題：為HTML輸出引入更多主題和自定義選項。
• • Interactive GUI ：為更喜歡GUI而不是CLI的用戶開發圖形用戶界面。
• • 增強的圖像支持：改進圖像嵌入，並具有調整大小，對齊和字幕的選項。

我們始終對建議和反饋開放。如果您有一個未在此處列出的想法，請與我們分享！

？貢獻

總是歡迎捐款！無論是功能請求，錯誤修復還是新想法，都可以隨意提交拉動請求還是打開問題。讓我們一起增強此工具！請務必閱讀貢獻文件以了解更多貢獻詳細信息。

執照

該項目已根據MIT許可獲得許可。