TextScribe

Textscribe - преобразователь Markdown

Конвертер Marckdown-это надежная утилита командной строки, построенная с ржавчиной. Он предназначен для преобразования файлов разметки в формат HTML, EPUB & PDF без усилий. С помощью мощности ящика «Овапленного», он обеспечивает точное анализ и рендеринг содержимого уценки.

Оглавление

• ? Функции
• Установка
• ? Использование
  • Пример
• ? Параметры
• ? Будущая дорожная карта
• ? Внося
• Лицензия

? Функции

• Swift Conversion : мгновенно преобразовать файлы разметки в HTML, PDF & EPUB.

• Интуитивно понятный интерфейс : удобный интерфейс командной строки, работающий на ящике clap .

• Поддержка Rich Markdown : поддерживает широкий спектр синтаксиса Markdown, включая заголовки, параграфы, списки, акцент, ссылки, изображения (с внедрением Base64) и кодовые блоки.

• Параметры настройки : выберите конкретные функции разметки, такие как таблицы и ударные, используя опции pulldown-cmark .

• Гибкий вывод : Сохраните сгенерированные HTML или EPUB в указанное местоположение, скопируйте его непосредственно в буфер обмена или предварительно просмотрите его в веб -браузере по умолчанию.

• Тема : стиль вашего HTML -вывода с разными темами.

Установка

1. Настройка окружающей среды Rust : если вы не установили ржавчину и груз, получите их с официального сайта 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> : Путь к вашему файлу разметки.
• <output-file> : (Необязательно) Путь для выхода HTML. Если не предоставлено, и не используются ни буфер, ни параметры браузера, будет вызвана ошибка.
• --theme <theme-name> : выберите тему (варианты: по умолчанию, темный, свет).
• --clipboard : скопируйте сгенерированный HTML непосредственно в буфер обмена.
• --browser : предварительно просмотрите сгенерированный 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

Для предварительного просмотра вывода в вашем веб -браузере по умолчанию:

 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

• Предварительный просмотр браузера : просмотрите сгенерированный HTML в веб -браузере по умолчанию.

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

? Будущая дорожная карта

• ✅ Поддержать больше типов изображений : поддержка большего количества типов изображений; GIFS, PNG, JPEG.
• ✅ Улучшенная обработка ошибок : улучшенная функциональность и ведение журнала для ошибок.
• ✅ Преобразование PDF : интеграция функциональности для преобразования сгенерированного HTML в формат PDF.
• • Расширенная темация : введите больше тем и параметров настройки для вывода HTML.
• • Интерактивный графический интерфейс : Разработайте графический пользовательский интерфейс для пользователей, которые предпочитают графический интерфейс, а не CLI.
• • Усовершенствованная поддержка изображений : улучшить встроение изображений с помощью вариантов изменения размера, выравнивания и подписей.

Мы всегда открыты для предложений и отзывов. Если у вас есть идея, которая здесь не указана, пожалуйста, поделитесь ею с нами!

? Внося

Вклад всегда приветствуются! Будь то запрос на функцию, исправление ошибок или новая идея, не стесняйтесь отправлять запрос на вытяжку или открыть проблему. Давайте расширим этот инструмент вместе! Обязательно прочитайте Appling File, чтобы узнать о дополнительных деталях взносов.

Лицензия

Этот проект лицензирован по лицензии MIT.