Ajout README

This commit is contained in:
Rick 2021-02-03 22:21:10 +01:00
parent 424d16bb11
commit 7c1f9c37b1
Signed by: Rick
GPG Key ID: 9570A7DB7CB2F436
1 changed files with 25 additions and 0 deletions

25
README.md Normal file
View File

@ -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 linstallation, 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 linstant que le plugin [Series](https://github.com/getpelican/pelican-plugins/tree/master/series).