TextScribe

TextScribe-マークダウンコンバーター

Markdownコンバーターは、R​​ustで構築された堅牢なコマンドラインユーティリティです。 MarkdownファイルをHTML、EPUB、およびPDF形式に簡単に変換するように設計されています。 「Pulldown-Cmark」クレートのパワーにより、マークダウンコンテンツの正確な解析とレンダリングが保証されます。

目次

• ？特徴
• インストール
• ？使用法
  • 例
• ？オプション
• ？将来のロードマップ
• ？貢献
• ライセンス

？特徴

• Swift Conversion ：Markdownファイルを即座にHTML、PDF、およびEPUBに変換します。

• 直感的なインターフェイス： clapクレートを搭載したユーザーフレンドリーなコマンドラインインターフェイス。

• リッチマークダウンのサポート：見出し、段落、リスト、強調、リンク、画像（base64埋め込み）、コードブロックなど、幅広いマークダウン構文をサポートします。

• カスタマイズオプション： pulldown-cmarkオプションを使用して、テーブルやStrikethroughなどの特定のマークダウン機能を選択します。

• 柔軟な出力：生成されたHTMLまたはEPUBを指定された場所に保存するか、クリップボードに直接コピーするか、デフォルトのWebブラウザーでプレビューします。

• テーマ：さまざまなテーマでHTML出力をスタイルします。

インストール

1. セットアップRust環境：Rustと貨物を設置していない場合は、Rustの公式Webサイトから入手してください。

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> ：マークダウンファイルへのパス。
• <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

• Strikethrough ：Strikethroughのフォーマットを有効にします。

   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 

？将来のロードマップ

• compleadより多くの画像タイプ：より多くの画像タイプをサポートします。 GIFS、PNG、JPEG。
• ersileエラー処理の改善：エラーのための機能とロギングの改善。
• pdf変換：機能を統合して、生成されたHTMLをPDF形式に変換します。
• • 拡張テーマ：HTML出力のテーマとカスタマイズオプションをさらに紹介します。
• • インタラクティブGUI ：CLIよりもGUIを好むユーザー向けのグラフィカルユーザーインターフェイスを開発します。
• • 強化された画像サポート：サイズ変更、アラインメント、キャプションのオプションで画像の埋め込みを改善します。

私たちは常に提案とフィードバックを受け入れています。ここにリストされていないアイデアがある場合は、私たちと共有してください！

？貢献

貢献はいつでも大歓迎です！機能リクエスト、バグ修正、または新しいアイデアであろうと、プルリクエストを送信するか、問題を開きます。このツールを一緒に強化しましょう！より多くの貢献の詳細については、貢献ファイルを読んでください。

ライセンス

このプロジェクトは、MITライセンスの下でライセンスされています。