Pelican

Pelican¹ est un programme en ligne de commande qui sert;

• à convertir un ensemble de dossiers contenant des fichiers textes (content) en site web statique fait de pages html (output),
• à tester le résultat (output) depuis un serveur web local intégré,
• à publier le résultat (output) vers un espace d'hébergement de sites web.

Installer Pelican dans un environnement dédié

Nous utiliserons Pelican dans un environnement Python créé avec l'utilitaire virtualenv.

Lorsque votre environnement dédié sera créé, la commande suivante installera le programme Pelican avec le plugin Markdown.

source ~/virtualenvs/pourpelican/bin/activate
python -m pip install "pelican[markdown]"

Créer un dossier qui contiendra tout les sites web

Pour ranger un peu les choses, nous travaillerons dans le dossier websites qui sera créé à la racine de votre compte utilisateur·ice sur votre ordinateur. Ce dossier contiendra votre premier-site et peut-être les prochains que vous réaliserez.

mkdir -p ~/websites/premier-site

Le paramètre -p indique à la commande mkdir de créer le dossier demandé et son parent si il n'existe pas encore.

Créer un premier site Pelican dans ce dossier

cd ~/websites/premier-site
pelican-quickstart

Si la commande pelican-quickstart n'est pas disponible, vérifiez que vous êtes bien dans un votre environnement dédié et activé. Voir virtualenv.

Elle vous posera un ensemble de questions à propos de votre futur site web et y créera les dossiers et fichiers de base avec lesquels commencer.

Quand une question est posée, ce qui est entre crochets [ exemple ] ou en majuscule (Y/n) est une réponse par défaut.

Ces réponses seront prises en compte en tapant directement sur la touche Enter ↵.

Vous pouvez écrire autre chose avant de pousser sur Enter ↵ pour remplacer les réponses par défaut.

Liste des questions posées

• Where do you want to create your new web site? [.]

  C'est le dossier courant . ou, si vous avez suivi ce qui est en amont, le dossier ~/websites/premier-site`

• What will be the title of this web site?

  C'est le titre de votre site web qui apparaitra dans la barre de titre de votre navigateur quelque soit la ou les pages que vous ajouterez à votre site web.

• Who will be the author of this web site?

  C'est le nom de l'auteur·ice par défaut des pages et des articles de votre futur site web.

• What will be the default language of this web site? [fr]

  C'est la langue utilisée pour vos pages et article. La prise en compte de plusieurs langue est possible dans Pelican², mais elle n'est pas abordée ici.

• Do you want to specify a URL prefix? e.g., https://example.com (Y/n)

  Vous pouvez répondre non n, cela ne nous empêchera pas de poursuivre la découverte de Pelican. Mais si vous savez déjà derrière quelle adresse URL sera hébergé votre site web, vous pouvez la renseigner.

• Do you want to enable article pagination? (Y/n)

  La pagination est utile si vous avez un grand nombre d'article. C'est ce qui créera des boutons « page suivante, précédente, première, dernière » après un certain nombre d'articles que vous pourrez définir au leu de lister tout les articles sur une seule page.

• What is your time zone? [Europe/Rome]

  Vous pouvez remplacer par Europe/Brussels par exemple ou bien vous référez à la liste de noms de fuseaux horaires³.

• Do you want to generate a tasks.py/Makefile to automate generation and publishing? (Y/n)

  Vous pouvez répondre non n sauf Si vous savez déjà où sera hébergé votre futur site web et par quels moyens l'envoyer sur un serveur. Nous n'en aurons pas besoin pour ce didacticiel.

En répondant non à la dernière question

La commande se termine et ajoute du contenu dans le dossier du premier-site

tree ~/websites/premier-site
/home/VOTRE_NOM/websites/premier-site
├── content
├── output
├── pelicanconf.py
└── publishconf.py

3 directories, 2 files

En répondant oui à la dernière question

D'autres questions suivent à propos de l'hébergement du premier-site.

TODO à propos de l'hébergement. TODO à propos du Makefile.

tree ~/websites/premier-site
/home/VOTRE_NOM/websites/premier-site
├── content
├── Makefile
├── output
├── pelicanconf.py
├── publishconf.py
└── tasks.py

3 directories, 4 files

Utiliser le serveur web de Pelican

Pelican permet de créer un mini serveur web localement sur votre ordinateur pour voir le résultat de votre travail.

pelican -l -r

Si la commande pelican n'est pas disponible, vérifiez que vous êtes bien dans un votre environnement dédié et activé. Voir virtualenv.

Le serveur web de Pelican doit être lancé depuis le dossier du site web que l'on souhaite tester, par exemple ~/websites/premier-site.

Le site web sera consultable à l'adresse http://localhost:8000.

Pour interrompre ce programme vous pouvez utiliser le raccourci clavier CTRL + c.

La suite (bientôt)

• publier votre premier site
• copier un site existant
• utiliser un dépôt
• utiliser truc comme codium

pelican --print-settings | grep THEME
    'THEME': '/home/tierce/virtualenvs/pelican/lib/python3.11/site-packages/pelican/themes/notmyidea',
    'THEME_STATIC_DIR': 'theme',
    'THEME_STATIC_PATHS': ['static'],
    'THEME_TEMPLATES_OVERRIDES': [],

pelican --print-settings MARKDOWN

MARKDOWN:
{'extension_configs': {'markdown.extensions.codehilite': {'css_class': 'highlight'},
                       'markdown.extensions.extra': {},
                       'markdown.extensions.meta': {}},
 'output_format': 'html5'}