Tutoriels

Ce chapitre a pour but de prendre en main rapidement les fonctionnalités de base de VenC. Pour une utilisation avancée de VenC, se référer au chapitre Manuel d'utilisation.

Créer son blog en moins de 5 minutes !

Et ouais, c'est possible !

Dans un terminal, tapez la commande suivante :

venc --new-blog "MonSuperBlog"

Après cette commande, VenC a créé un répertoire appelé "MonSuperBlog" à l'endroit où vous avez lancé la commande. Ce répertoire contient toutes les informations de votre blog. Il faut donc le garder précieusement, et même en faire des sauvegardes de temps à autre !

jeanrochefort@anonymous ~ $ venc --new-blog "MonSuperBlog"

VenC: Votre blog a été créé!

jeanrochefort@anonymous ~ $ ls MonSuperBlog/

blog blog_configuration.yaml entries extra includes templates theme

La prochaine étape consiste à paramétrer un peu le blog. Pour ça, il suffit d'éditer le fichier blog_configuration.yaml à la racine de ce répertoire. Vous pourrez notamment y définir le nom de votre blog, sa langue, ses mots-clefs, entre autres choses parmi les nombreux paramètres à configurer, ou à laisser par défaut.

author_description: 'Je suis Jean Rochefort et je suis mort, mais je reviendrai.'
author_name: 'Jean Fucking Rochefort'
blog_description: 'Les tribulations du roy de France Jean Rochefort en direct du paradis.'
blog_keywords: 'cinéma,moustache,punchline,boloss'
blog_language: 'fr'
blog_name: 'Le blog de Jean Rochefort, élu roy de France par les internets.'
license: 'Licence royale'

Pour plus d'informations sur la configuration du blog, rendez-vous ici.

Et voilà, c'est terminé ! Votre blog est prêt à l'emploi !

Si vous avez rencontré une difficulté durant ce tutoriel, jetez un œil à la FAQ, la solution s'y trouvera certainement !

Créer une nouvelle publication

Pour créer une nouvelle publication, placez-vous dans le répertoire de votre blog et tapez la commande suivante :

jeanrochefort@anonymous ~ $ venc --new-entry "Ma Première Publication"

vous pouvez également utiliser la version racourcie de la commande :

jeanrochefort@anonymous ~ $ venc -ne "Ma Première Publication"

Cette commande crée la publication et la stocke dans le répertoire entries de votre blog.

Astuce : l'éditeur de texte par défaut définit dans votre fichier de configuration devrait être nano. Quand vous créez une nouvelle publication, VenC l'ouvre pour vous dans l'éditeur de texte ainsi définit. Vous pouvez changer votre éditeur de texte dans blog_configuration.yaml.

Une publication vierge ressemble à ça :

authors: ''
categories: ''
tags: ''
title:
---VENC-BEGIN-PREVIEW---
---VENC-END-PREVIEW---

C'est un document découpé en trois parties :

  • La première partie contient les méta-données de la publication au format YAML.
  • La seconde peut contenir un résumé de la publication pour la prévisualisation.
  • La troisième contient le corps de votre publication.

Astuce : par défaut VenC utilise la syntaxe Markdown, vous pouvez cependant changer le langage de balisage. Plus d'informations à ce sujet ici.

Pour en savoir plus sur les méta-données des publications, rendez-vous ici.

Une fois que vous avez terminé d'écrire le meilleur billet de blog de tous les internets, enregistrez, et c'est fini ! Il n'y a plus qu'à publier !

Publier

Vous avez donc écrit un ou plusieurs articles et vous voulez voir ce que ça donne ! Placez-vous dans le répertoire de votre blog et lancez la commande

jeanrochefort@anonymous ~ $ venc --export-blog gentle

Cette commande va créer les pages HTML de votre blog en utilisant le thème gentle. Pour connaître les thèmes disponibles, tapez :

jeanrochefort@anonymous ~ $ venc -it

Vous pouvez alors recompiler votre blog en passant en paramètre le nom d'un des thèmes dans la liste, en vert.

Si vous souhaitez faire votre propre thème HTML/CSS vous pouvez vous aider du thème dummy qui contient un squelette HTML pouvant servir de base. Pour installer un thème dans votre blog (généralement pour le modifier), par exemple gentle, utilisez la commande :

jeanrochefort@anonymous ~ $ venc -it gentle

Pour compiler le blog avec ce thème bien à vous :

jeanrochefort@anonymous ~ $ venc --export-blog

VenC utilise par défaut le thème local quand aucun nom de thème ne lui est précisé.

Pour en savoir plus sur les thèmes, rendez-vous ici

Le contenu de votre site est maintenant disponible dans le répertoire blog de votre blog. Pour visualiser le résultat, vous pouvez utiliser la commande :

jeanrochefort@anonymous ~ $ venc --serv

VenC crée un serveur HTTP local accessible par défaut à l'adresse suivante :

http://localhost:8888

(Une fois que vous aurez fini de visualiser le résultat, pour arrêter le serveur HTTP local, il suffit de taper CTRL+C dans le terminal actif)

Et voilà ! Le moins que l'on puisse dire, c'est que vous pesez lourd dans le game maintenant !

Mettre en ligne

Maintenant que votre blog vous plaît, il est temps de le mettre en ligne et d'en faire profiter les internautes !

Il y a plusieurs façon de faire. La première approche consiste à copier manuellement le contenu du répertoire blog vers le serveur en ligne. Mais ce peut être un peu fastidieux quand on sait que VenC peut prendre en charge le transfert de votre blog.

Pour que VenC puisse mettre en ligne votre blog, vous devez lui fournir quelques informations dans le fichier blog_configuration.yaml. Pour cela, renseignez le champ ftp_host avec l'adresse du serveur FTP de destination. Renseignez également le sous-champ ftp du champ path en indiquant le chemin de destination où sera copié le contenu de votre blog, sur le serveur en ligne.

Attention : soyez vigilant en renseignant le champ ftp qui détermine le chemin de destination. Au moment de l'exportation en ligne, VenC efface le contenu de ce répertoire ! Assurez-vous de savoir ce que vous faites !

Après avoir fournis les informations dont VenC a besoin, vous pouvez copier votre blog sur le serveur de destination :

jeanrochefort@anonymous ~ $ venc --remote-copy

De cette façon, VenC vous demandera de vous authentifier auprès du serveur. C'est seulement après vous être authentifié que le transfert commencera. Vous pouvez aller vous chercher un café, ou un jus de tomate. Perso, je préfère le jus de tomate. Avec du parmesan et du Tabasco.

Une autre façon de faire est de compiler le blog et de l'exporter en ligne en une seule commande :

jeanrochefort@anonymous ~ $ venc --export-via-ftp [thème à préciser en option]

Comme pour la commande précédente, vous devrez vous authentifier. Vous pouvez également préciser un nom de thème avec lequel vous voulez compiler votre blog.

Voilà, c'est tout ! Normalement, votre blog devrait être en ligne avec ça !