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许可获得许可。