RSS
MkDocs permite incluir un agregador RSS para facilitar las notificaciones a posibles lectores cada vez que se agregue contenido al blog del proyecto.
Instalación
Se necesita un complemento externo para que funcione el agregador RSS:
Habilitación
El agregador debe habilitarse desde el archivo de configuración YAML:
# archivo "mkdocs.yml"
plugins:
- ...
- rss:
enabled: true # habilitado por defecto
match_path: "blog/posts/.*" # ruta de los posts
date_from_meta:
as_creation: date.created
as_update: date.updated
Renderizado en local
El renderizado del archivo XML resultante puede llevar mucho tiempo adicional. Para minimizar este problema en entornos locales se puede deshabilitar el plugin manualmente.
Campos obligatorios y caracteres permitidos
El plugin exige configurar correctamente los campos site_name,
site_url y site_description
para generar el documento XML correctamente.
Asimismo se debe tener cuidado con el uso de caracteres reservados por el protocolo HTTP
(&, !, =, etc)
porque se puede dar lugar a la creación de un archivo XML mal renderizado.
Ejemplo:
site_name: MarkDown & MkDocs da error,
en tanto que site_name: MarkDown - MkDocs es correcto.
Test
El plugin crea un archivo XML llamado feed_rss_created.xml que se ubica en la ruta raíz del sitio web.
Por ejemplo, si se usa el live server la ruta habital será http://localhost:8000/feed_rss_created.xml.