nuir/README.md

53 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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
### Auteur
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')),
}
}
```
### 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'
}
```
## Support de plugins
Ce thème supporte les plugins suivant :
* [Series](https://github.com/pelican-plugins/series)
* [Drafts](https://github.com/noirbizarre/pelican-drafts)