diff --git a/README.md b/README.md new file mode 100644 index 0000000..500b7ae --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Thème pour Pelican + +Ce thème a été en premier designé par [Eban](https://eban.bzh) avant d’être refait à ma sauce. Je me suis aussi beaucoup inspiré de [medius](https://github.com/onur/medius). + +## Installation + +Pour l’installation, suivez la [documentation officielle](https://docs.getpelican.com/en/4.5.4/pelican-themes.html). + +## Variables + +Vous pouvez définir une description sur la page auteur ainsi que des liens vers Twitter, Github, Mastodon et Gitea : + +``` +NUIR_AUTHORS = { + 'John': { + "description": "Lorem ipsum", + "links": (('mastodon', 'link'), + ('github', 'link')), + } +} +``` + +## Support de plugins + +Ce thème ne supporte pour l’instant que le plugin [Series](https://github.com/getpelican/pelican-plugins/tree/master/series).