Octor

欢迎使用 Octor，这是一个灵活的命令行工具，专为轻松管理和转换 markdown 文件而设计。无论是整合文档、准备网页发布的内容，还是简单地组织 markdown 文件，Markdown Merger 都可以帮助您简化流程。这款工具以简洁和高效为核心，支持将多个 markdown 文件合并为一个文档，并将 markdown 转换为 HTML。

功能

• 合并 Markdown 文件：将多个 markdown 文档合并为一个，便于管理和组织您的文档或笔记。此功能非常适合准备综合指南或合并笔记。
• 将 Markdown 转换为 HTML：无缝将您的 markdown 文件转换为 HTML 格式，便于网页发布或进一步转换为 PDF 等其他格式。配置灵活性：使用 TOML 格式的配置文件自定义合并过程。排除特定文件，定义合并顺序等，使输出符合您的需求。
• 命令行简洁：所有操作都通过简单的命令行指令完成，让您能够自动化和脚本化流程。

入门指南

首先，确保您的系统上已安装 Rust，以便使用 Octor。然后，按照以下步骤开始使用

安装：克隆此存储库，并使用 Cargo（Rust 的包管理器和构建系统）构建工具。

cargo build --release

运行 Markdown Merger：导航到包含 markdown 文件的目标目录，并使用适当的命令运行工具。

合并 Markdown 文件：要合并多个 markdown 文件到一个文件中，使用 merge 子命令。可选地，您可以指定自定义输出文件名和配置文件以进行高级合并选项。

octor merge --filename "output.md" --config_file "config.toml"

如果没有指定文件名或配置文件，则默认使用 output.md 和 octor.toml。

将 Markdown 转换为 HTML：使用 convert 子命令将 markdown 文件转换为 HTML。只需指定要转换的 markdown 文件即可。

octor convert --filename "your_file.md"

详细输出：为了详细的操作日志，尤其是在调试或了解合并/转换过程时非常有用，请将 --verbose 标志添加到任何命令中。

octor merge --verbose

贡献

我们欢迎贡献！如果您有改进建议，请随意 fork 存储库并提交 pull request。对于重大更改，请首先打开 issue 以讨论您想要更改的内容。

许可证：此工具开源，采用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。

享受使用 Octor 满足所有 markdown 处理需求！