Ir al contenido principal

Descripción

pymd es un wrapper para la librería Python Markdown, basicamente te permite tener un HTML completo a comparación de lo que te devuelve la librería.

También incluye:

  • Proceso en batch (en una carpeta o usando .list) con extensiones .md, .txt o .markdown
  • Especificar una carpeta de resultados/output (con creación automática)
  • Incluye todas las extensiones de Python Markdown y hasta podes especificar las tuyas!
  • Combinar los archivos en un HTML grande o crear un librito con links de navegación; hasta podes crear tu propio index!
  • CSSed: trae un no-tan-feo CSS embebido (hasta podes cambiar entre tipografía sans y serif) o linkear a una que prefieras.
  • Encabezados para los archivos! Así podes compartir el mismo metadata (como tu hermoso nombre y tu creativo título) en todos los archivos o cuando combinas y te olvidaste poner un título principal.
  • Wiki links: [](archivo|ruta) -> título del archivo linkeado](ruta final)

    Uso

    La sintaxis es la siguiente:

     pymd.py SOURCE [--output FOLDER [--flat]] [--header FILE ] [--exts LIST ]
                [ --css FILE | --serif ] 
                [ book [--index FILE --nav] | merge [--toc(0, 1, 2, 3, 4, 5)] ]

    SOURCE
    Archivo, carpeta o .list. Un .list es un archivo que contiene las rutas a los archivos en el orden que se convertirán.
    --output FOLDER, -o FOLDER
    Carpeta de salida
    --flat
    No mantener la estructura de la carpeta
    --header FILE
    Archivo Header, mayormente para unir archivos. Podría contener título, fecha y toc (como [TOC_HERE]). Necesario si el archivo header no se llama _header.txt/.md/.markdown en la carpeta o .list
    --extensions
    Listado de otras extensiones
    --css FILE
    CSS personalizado con ruta (como incluído en href). Default: embebido
    --serif
    (CSS embebido) elegir entre sans (False) o serif (True). Default: False.
    --merge, merge
    Unir archivos
    --toc
    Profundidad máxima de TOC (para [TOC_HERE]). Default: 0 (todos). Opciones: 0, 1, 2, 3, 4, 5
    --book, book
    Crear un libro con navegación (next/prev) e index
    --nav, -n
    (Para book) usar titulos en la navigación
    --index FILE
    Index personalizado para book. Puede usar wikiLinks. Necesario si el archivo index no se llama _index.txt/.md/.markdown en la carpeta o .list

    book automaticamente crea un index con links a todos los archivos, a no ser que especifiques uno personalizado con --index. Por default, usa links "next/previous" (siguiente/anterior) para la navegación. Sin embargo, podes usar -n para usar los títulos de los documentos:

    Ejemplo de links de navegación con títulos

    También podes usar un archivo de header. Este es un archivo normal con metadatos: título principal del documento/proyecto, fecha, comentario, etc. como en un bloque meta-data; este es el archivo donde el script busca el [TOC_HERE] (útil al unir). Un ejemplo:

    Title: Word domination project
    Summary: Ideas for the word domination project
    Comment: Missing budget list
    
    [TOC_HERE]

    Ejemplo de un archivo header/encabezado

    Notar como el meta-data es convertido:

    Metadata HTML
    Title <h1 class="title">
    Author <h2 class="author">
    Date <h3 class="date">
    Summary <p class="summary">
    Comment <p class="comment">
    the rest como una lista de definición

    Si querés cambiar la profuncidad del TOC, usá la opción --toc [numero]. Acá un ejemplo donde muestra el primer nivel:

    Ejemplo del TOC mostrando el primer nivel

    Descarga

    pymd 0.5.5
    También en Github

    Python >2.7, Python 3

    Cambios

    Versión 0.5.5

    • Modified configuration: now global
    • fix relatives paths (book)
    • Wiki links to local files must use [](file|nice_file.md) syntax

    Versión 0.5.4

    • code refactoring: to classes, def changes, vars...
    • fix bug when using a .list & output folder (not having name)
    • python 3.3 compatibility

    Versión 0.5.3

    • check book pages for navigation (if only one file, disallow)
    • fix book navigation bug (having 2 files, and linking next with the 2nd, when shouldn't)
    • fix: output path with one file
    • fix: finding H1 HTML tag
    • files are saved according to source dir tree
    • option to save files in one depth directory
    • relative links for book
    • wiki links parsing ([](path) -> [title linked file](output_path))
    • custom index for book
    • minor python 3 compatibility
    • toc depth filtering
    • navbar: change css, style links, titles for navbar (option)
    • better handling for merge/book options
    • fix: command line options

    Versión 0.5

    • fix bug in output folder (merged files)
    • book support (resulting html files will have navigational links)
    • User can specify installed extensions
    • output folder support, with folder creation
    • fixed bugs
    • html5fying

    Versión 0.3

    • .list support (convert & merge files according order)
    • filter files to parse by extensions

    Versión 0.2

    • add merge option
    • add embeded CSS

    Versión 0.1

    • Created