Narval

Générateur de blog statique.

Guide rapide

Documentation

Guide de démarrage rapide de Narval, un générateur de blog statique. Une documentation plus complète est également disponible sur ce blog si besoin.

1. Prérequis

Disposer de :

  • Python 3 (ou version supérieure);
  • Tenjin;
  • Git (facultatif si tu souhaites ni installer Narval en ligne de commande, ni héberger ton futur blog gratuitement sur Github Pages).

Pour installer Tenjin, tape dans un terminal :

sudo easy_install Tenjin

Pour vérifier la présence de Python et Git dans ton ordinateur, tape dans un terminal :

python -V

Et :

git --version

Si un numéro de version apparaît pour chacune des commandes, c’est que tu peux passer à l’étape 2. Vérifie tout de même bien que la version de Python est supérieure ou égale à 3.

2. Télécharger Narval

Narval peut s’installer de deux façons.

En lignes de commande :

git clone https://github.com/narvalblog/narval

Depuis Github :

En suivant ce lien, puis en cliquant sur « Clone or download » (bouton vert en haut de page) et enfin en cliquant sur « Download ZIP ». Une fois l’archive téléchargée, il faut la décompresser.

3. Une petite démonstration ?

Rien de tel que de générer le blog de démonstration soi-même pour comprendre comment ça marche. Ouvre le terminal à la racine du dossier téléchargé à l’étape 2 et tape ceci :

python3 build.py

Deux dossiers sont créés dans le dossier : _NARVAL/ et _NARVAL-local/. Le premier contient le blog à publier sur Internet. Le second contient le blog consultable sur ton propre ordinateur. Ce bon narval, à travers le terminal, te propose de consulter le blog. Appuie sur la touche Entrée : le blog s’ouvre dans ton navigateur Internet.

4. Contenu et configuration

Singer ! Le fonctionnement de Narval, grâce au blog de démonstration fourni, est aisément compréhensible par mimétisme. En somme, tu peux t’inspirer du blog de démonstration pour faire ton propre blog, sans lire la documentation complète.

La plupart des fichiers du dossier content/ s'ouvre à l'aide d'un éditeur de texte pour pouvoir être lus correctement et modifiés. Le bloc-note par défaut peut suffire, mais je te recommande Atom, Geany ou encore Brackets qui sont tous les trois gratuits si tu ne sais pas lequel choisir.

Le dossier content/ rassemble le contenu de ton blog. Regarde un peu dans les sous-dossiers, ouvre les fichiers et compare avec ce que tu vois dans ton navigateur (étape 3). Tu comprendras rapidement bien des choses. Tu peux alors commencer à créer des articles et tes pages, changer la configuration du blog, etc. Si tu es un peu perdu ou que tu veux aller plus loin, voici un petit récapitulatif de ce qui se trame dans le dossier content/ :

  • CONFIG permet de configurer le blog. C’est dans ce fichier que l’on peut par exemple changer le titre, le thème ou le nombre d’articles par page, spécifier une URL, mettre un identifiant Disqus pour afficher un système de commentaires, etc;
  • attachments/ regroupe toutes les pièces jointes à tes articles et à tes pages (images, sons, vidéos, fichiers à télécharger, etc.);
  • pages/ regroupe les pages du blog et, optionnellement, un fichier CATEGORIES et un fichier AUTHORS;
  • posts/ regroupe les articles du blog et, optionnellement, un fichier CATEGORIES et un fichier AUTHORS;
  • templates/ regroupe tous les modèles de pages du blog. Ces modèles sont écrits avec un mélange de HTML et de Python. Ils permettent de définir ce que le blog affichera et comment;
  • themes/ contient le thème du blog, son style graphique (feuilles de styles CSS, images du thèmes, etc.);

Les modèles de pages sont fortement liés à un thème. Les thèmes proposés avec Narval sont tous compatibles avec les fichiers du dossier templates/.

La documentation complète peut également t’être utile.

5. Aller, vas-y !

Une fois ton blog bien configuré, bien beau et avec du contenu que tu trouves intéressant à partager, tu fais à nouveau un petit :

python3 build.py

Si des erreurs s’affichent, tu les corriges et tu réessayes. Sinon, tu peux y aller ! Tu héberges où tu veux le contenu de _NARVAL/, mais je te propose ci-dessous deux solutions gratuites qui me plaisent bien ♥.

Github Pages :

Github permet d’héberger gratuitement ses pages (et donc son blog). C’est là tout l’avantage du blog statique. Ce lien (en anglais), permet de comprendre comment s'y prendre pour héberger son blog sur Github Pages. Je réaliserai prochainement un guide en français pour mettre son blog Narval sur Github Pages.

Peer To Peer (P2P) :

Ton blog sera d’abord hébergé chez toi, puis chez toutes les personnes qui l’auront consulté. Ainsi, quand ton ordi sera éteint, les pages de ton blog resteront toujours consultables. De plus, l’espace de stockage de ton blog est sans limites. L’inconvénient actuel est que peu de monde navigue sur Internet en P2P, mais si personne ne s’y met, l’inconvénient persistera.

Tout cela est encore expérimental, mais tu peux essayer ZeroNet et Beaker.

Accueil
→ Thème Minival