Guía Markdown de Markdown Tool

Markdown Tool es una herramienta de línea de comandos con la que podrás realizar diversas tareas.

Acerca de Markdown Tool

Markdown Tool está disponible para Windows, Linux y macOS. Para usar Markdown tool necesitarás ciertos conocimientos de la línea de comandos. Si nunca la has usado, puedes consultar el tutorial de introducción a la línea de comandos.

Imagen de Markdown Tool

Con Markdown Tool podrás realizar cosas como descargarte las imágenes de un docuemnto Markdown, ya esté localizado localmente o en alguna fuente external. Luego podrás enlazar estas imágenes desde tu sistema local o convertirlas a diferentes formatos.

También podrás convertir los documentos a HTML o a PDF, entre otros formatos.

Instalación de Markdown Tool

Para instalar Markdown Tool tendrás que abrir una ventana de línea de comandos y ejecutar este comando, para el que necesitarás tener Git instalado en tu sistema:

git clone "https://github.com/artiomn/markdown_articles_tool"

Luego ejecuta el siguiente comando, que requiere que tengas PIP instalado en tu sistema:

pip3 install -r markdown_articles_tool/requirements.txt

Seguidamente ejecuta este comando para instalar Markdown Tool:

pip3 install markdown-tool

Cómo usar Markdown Tool

Los comandos de Markdown Tool se ejecutan desde la terminal de comandos y siguen esta sintaxis:

markdown_tool [opciones] <path_o_url_del_archivo>

Estas son las opciones que Markdown Tool acepta por ahora:

  -h, --help            mostrar este mensaje de ayuda y salir
  -D {disabled,names_hashing,content_hash}, --deduplication-type {disabled,names_hashing,content_hash}
                        Deduplicar imágenes, utilizando hash de contenido o SHA1(image_name) (defecto: disabled)
  -d IMAGES_DIRNAME, --images-dirname IMAGES_DIRNAME
                        Carpeta en la que descargar las imágeness (posibles valores: $article_name, $time, $date, $dt, $base_url) (defecto: images)
  -a, --skip-all-incorrect
                        omitir todas las imágenes incorrectas (defecto: False)
  -E, --download-incorrect-mime
                        descargar "imágenes" con tipo MIME no reconocido (defecto: False)
  -s SKIP_LIST, --skip-list SKIP_LIST
                        omitir URL de la lista separada por comas (or file with a leading '@') (defecto: None)
  -i {md,html,md+html,html+md}, --input-format {md,html,md+html,html+md}
                        formato de entrada (defecto: md)
  -l, --process-local-images
                        [DEPRECATED] Procesar imágenes locales (defecto: False)
  -n, --replace-image-names
                        Replace image names, using content hash (defecto: False)
  -o {md,html}, --output-format {md,html}
                        formato de salida (defecto: md)
  -p IMAGES_PUBLIC_PATH, --images-public-path IMAGES_PUBLIC_PATH
                        Ruta pública a la carpeta de imágenes descargadas (posibles valores: $article_name, $time, $date, $dt, $base_url)
  -P, --prepend-images-with-path
                        Guardar rutas relativas de imágenes (defecto: False)
  -R, --remove-source   Eliminar o sustituir el archivo fuente (defecto: False)
  -t DOWNLOADING_TIMEOUT, --downloading-timeout DOWNLOADING_TIMEOUT
                        cuántos segundos hay que esperar antes de que falle la descargad (defecto: -1)
  -O OUTPUT_PATH, --output-path OUTPUT_PATH
                        nombre o ruta del archivo de salida del artículo
  --verbose, -v         Registro más detallado (defecto: False)
  --version             devolver número de versión

Soporte Markdown de Markdown Tool

Markdown Tool soporta los siguientes elementos de la sintaxis básica de Markdown:

Elemento	Soporte	Notas
Encabezados	Sí
Párrafos	Sí
Saltos de línea	Sí
Negrita	Sí
Cursiva	Sí
Citas	Sí
Listas ordenadas	Sí
Listas no ordenadas	Sí
Código	Sí
Línea horizontal	Sí
Enlaces	Sí
Imágenes	Sí
HTML	Sí
Tablas	Sí
Bloques de código avanzados	Sí
Resaltado de sintaxis	Sí
Notas al pié	No
IDs de cabecera	No
Listas de definiciones	No
Texto tachado	Sí
Listas de tareas	Sí
Emojis (copiar y pegar)	Sí
Emojis (shortcodes)	No
Enlaces automáticos	Sí
Deshabilitar enlaces automáticos	Sí

Más información

Consulta el siguiente enlace para obtener más información acerca de Markdown Tool: