TextScribe

TextScribe - Converter Markdown

El convertidor Markdown es una utilidad de línea de comandos robusta construida con óxido. Está diseñado para transformar los archivos de Markdown en formato HTML, EPUB y PDF sin esfuerzo. Con la potencia de la caja 'pulldown-cmark', garantiza un análisis y representación precisos del contenido de markdown.

Tabla de contenido

• ? Características
• Instalación
• ? Uso
  • Ejemplo
• ? Opción
• ? Hoja de ruta futura
• ? Que contribuye
• Licencia

? Características

• Conversión Swift : convierta instantáneamente sus archivos de Markdown en HTML, PDF y EPUB.

• Interfaz intuitiva : una interfaz de línea de comandos fácilmente fácil de usar alimentada por la caja clap .

• Soporte de markdown rico : admite una amplia gama de sintaxis de Markdown, incluidos encabezados, párrafos, listas, énfasis, enlaces, imágenes (con incrustación base64) y bloques de código.

• Opciones de personalización : elija funciones de markdown específicas como tablas y striKethrough utilizando las opciones de pulldown-cmark .

• Salida flexible : guarde el HTML o EPUB generado en una ubicación especificada, copie directamente en el portapapeles o presente prevélo en su navegador web predeterminado.

• Tema : diseñe su salida HTML con diferentes temas.

Instalación

1. Configuración de entorno de óxido : si no ha instalado óxido y carga, obtenga el sitio web oficial de Rust.

2. Clon el repositorio :

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

3. Navegue al directorio del proyecto :

    cd TextScribe

4. Compilar el proyecto :

    cargo build --release 

? Uso

Para convertir su Markdown en HTML o EPUB, use el siguiente comando:

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

• <input-file> : ruta a su archivo de markdown.
• <output-file> : (opcional) ruta para la salida HTML. Si no se proporciona y no se utilizan el portapapeles ni las opciones de navegador, se solicitará un error.
• --theme <theme-name> : Elija un tema (Opciones: predeterminada, oscura, luz).
• --clipboard : Copie el HTML generado directamente al portapapeles.
• --browser : Vista previa del HTML generado en su navegador web predeterminado.
• --epub : Genere un archivo EPUB. Perfecto para los lectores.

Ejemplo:

Convertir example.md a HTML usando el tema oscuro y guárdelo como output.html :

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

Para copiar la salida directamente al portapapeles:

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

Para obtener una vista previa de la salida en su navegador web predeterminado:

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

Convertir example.md a ePub usando el tema oscuro y guárdelo como output.epub :

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

? Opción

• Tema : diseñe su salida HTML.

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

• Tablas : Habilite el formato de tabla en su Markdown.

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

• Strikethrough : habilite el formato de strikethrough.

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

• Salida del portapapeles : copie el HTML generado al portapapeles.

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

• Vista previa del navegador : Vea el HTML generado en su navegador web predeterminado.

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

? Hoja de ruta futura

• ✅ Soporte de más tipos de imágenes : soporte para más tipos de imágenes; GIFS, PNG, JPEG.
• ✅ Manejo de errores mejorado : funcionalidad y registro mejorados para errores.
• ✅ Conversión de PDF : Integre la funcionalidad para convertir el HTML generado en formato PDF.
• • Tema extendida : introduzca más temas y opciones de personalización para la salida HTML.
• • GUI interactivo : desarrolle una interfaz gráfica de usuario para usuarios que prefieren la GUI sobre CLI.
• • Soporte de imagen mejorado : Mejore la incrustación de imágenes con opciones de cambio de tamaño, alineación y subtítulos.

Siempre estamos abiertos a sugerencias y comentarios. Si tiene una idea que no está en la lista aquí, ¡compártela con nosotros!

? Que contribuye

¡Las contribuciones siempre son bienvenidas! Ya sea que se trate de una solicitud de función, corrección de errores o una nueva idea, no dude en enviar una solicitud de extracción o abrir un problema. ¡Mejoremos esta herramienta juntos! Asegúrese de leer el archivo contribuyente para conocer más detalles de contribuciones.

Licencia

Este proyecto tiene licencia bajo la licencia MIT.