nuir/README.md

54 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2021-02-03 22:21:10 +01:00
# 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
2021-08-20 18:47:19 +02:00
### Auteur
2021-02-03 22:21:10 +01:00
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')),
}
}
```
2021-08-20 18:47:19 +02:00
### Licence
Il est possible dutiliser une licence à mettre sur le contenu des articles. Il faut rajouter une valeur à la variable `NUIR_LICENCE` dans le fichier de configuration de Pelican.
Les suivantes sont natives au thème:
* CCBY
* CCBYSA
* CCBYND
* CCBYNCSA
* CCBYNCND
* GNUFDL
Pour mettre une autre licence ou un bouton personnalisé à cet emplacement, il faut utiliser la structure suivante:
```
NUIR_LICENCE = {
'link': 'lien qui redirige lutilisateur quand il clique sur limage',
'alt': 'alt de limage',
'image': 'chemin de limage'
}
```
2021-08-20 18:47:19 +02:00
2021-02-03 22:21:10 +01:00
## Support de plugins
2021-04-07 15:02:32 +02:00
Ce thème supporte les plugins suivant :
* [Series](https://github.com/getpelican/pelican-plugins/tree/master/series)
2021-04-07 15:02:32 +02:00
* [Drafts](https://github.com/noirbizarre/pelican-drafts)