Cuaderno de notas
Anotaciones sobre comandos, trucos y utilidades que he ido recopilando a lo largo del tiempo. Antiguamente en una libreta, ahora en un sitio web estático creado con Pelican.
Uso de Pelican
Antes de empezar a editar contenidos, hay que instalar la aplicación Pelican con soporte para Markdown:
pip install pelican[markdown]
Las instrucciones completas para usar el generador se pueden encontrar en la documentación de Pelican.
Añadir nueva entrada
Las nuevas entradas se añaden en ficheros Markdown .md
en el directorio
content
. El fichero debe tener la siguiente cabecera:
Title: <título de la entrada>
Date: <fecha de publicación en formato YYYY-mm-dd HH:MM>
Category: <categoría a la que corresponde la entrada>
Tags: <lista de tags, separados por coma>
Slug: <texto para la URL de la entrada>
Authors: José L. Patiño-Andrés
Summary: <frase de resumen de la entrada>
Tras dicha cabecera, se escribe la entrada en Markdown.
Resaltado de sintaxis (código)
Se puede generar contenido con resaltado de sintaxis a la hora de mostrar código fuente, comandos, etcétera. Para ello usamos la sintaxis de Markdown:
:::<LENGUAJE>
// Código fuente a mostrar...
Donde <LENGUAJE>
es uno de los lexers disponibles en la librería
Pygments, que es la que internamente usa
Pelican para generar contenido con resaltado de sintaxis.
Generar contenido
Al acabar de escribir la entrada, generamos el contenido HTML/CSS con el siguiente comando:
pelican content
Esto creará nuevos ficheros en el directorio output
(ignorado por Git).
Comprobación
Se puede navegar por el sitio para comprobar las entradas creadas con el siguiente comando:
pelican --listen
Podemos ahora ir a http://localhost:8000 para ver el resultado final generado por Pelican.