Castbuilder NPM

castbuilder

Licence

Un générateur de site statique pour le podcast. Une fois installé utilisez

castbuilder init depuis votre dossier pour initialiser l'arborescence
castbuilder render pour générer votre site. Utilisez castbuilder render -o pour effacer le dossier output/ avant le rendu.
castbuilder new pour créer un nouvel épisode. Utilisez castbuilder new -e pour avoir une création interractive

Informations

Attention! Ce projet n'est pas fait pour les gros projets de flux RSS. Il est plutôt là pour servir de complément à un flux principal, ou pour quelques épisodes, ou encore si vous avez besoin d'un flux vraiment sur votre site web. Si vous voulez un flux plus résistant, avec une belle interface graphique et hébergé en ligne gratuitement, vous pouvez utiliser Podcloud. Castbuilder est un peut pensé comme son petit frère spirituel, qui est là pour avoir les fonctions de bases.

Autre information, ce projet est encore en cours de développement. Il fonctionne en l'état, mais est loin d'être parfait! Si vous rencontrez des problèmes, n'hésitez pas à me les reporter dans les Issues ou sur Twitter !

J'ai quelques idées d'améliorations dans le futur, n'hésitez pas à suivre le développement du projet ici même dans la partie projet!

Changelog

Instalation

Pour installer le module, il faut commencer par télécharger NodeJS puis executez la commande :

npm install castbuilder -g

(Sur Linux il faut avoir les droits d'administration, utilisez sudo devant!)

Le module est installé 🎉!

Utilisation

Rendez vous dans le dossier où vous souhaitez installer votre site web (vous pourrez de toute façon le déplacer plus tard!) et executez dans un terminal de commande :

castbuilder init

Tous les fichiers par défauts seront installés à ce moment là. Petit explication des fichers. Déjà les fichiers sont des fichiers Markdown. Vous pouvez utiliser toute la sythaxe Markdown supportée par Showdown (le module que j'utilise pour transformer le Markdown en HTML). Toutes les infos sont ici.

Alors ouvront le premier fichier, information.md. Dedans il y aura toutes les informations globales de votre flux, et la description de celui si. Castbuilder utilise le principe des YAML Front Matter de Jekyll, n'hésitez pas à aller voir la documentation ici.

Pensez à sécuriser vos titres si ils contiennent le caractère ":". Entourez simplement votre chaîne de '.

Pour éditer vos fichiers Markdown, je vous conseille énormément Typora qui est vraiment un super éditeur Markdown et prend en compte tous les besoins de Castbuilder.

Voici à quoi correspondent les différents champs.

---
title: Titre de votre podcast
author: Votre nom
email: votre.email@example.com
category: Catégorie iTunes
subcategory: Sous catégorie iTunes
copyright: Le texte présent dans la balise Copyright
type: episodic/serial
image: Le nom de l'image de couverture de votre podcast! Elle doit être dans le dossier img/ (1400x1400 en 72ppi)
link: Le lien où sera accessible ce flux (sans index.html/feed.xml)
keyword: Les tags présents dans le flux
language: Le langage du flux
explicit: yes/no si explicite ou non
---
Sous cette ligne, entrez la description de votre podcast!

Vous pouvez faire de la mise en page en **gras par exemple** mais prenez en compte que tous les lecteurs ne le supporteront pas!

%website%
Tout texte entre ces éléments ne sera affiché uniquement sur le site web!
%/website%

%feed%
Et celui ci uniquement dans le flux RSS
%/feed%

Liste des catégories iTunes : castos.com/itunes-podcast-category-list
Les langages supportés dans les flux RSS : rssboard.org/rss-language-codes

Maintenant qu'on a vu le fichier information.md on va voir un peu comment créer un épisode!

Il vous suffit d'utiliser la commande

castbuilder new -e

Vous aurez quelques réponses à donner dans le terminal de commande et votre épisode sera créé automatiquement. (Vous pouvez aussi retirer l'argument -e pour créer vous même à la main l'épisode). Toutes les infos sur la commande dans le Wiki. Et pour savoir l'utilité de tous les champs de votre fichier .md, pareil, les infos sont dans le Wiki.

Voilà! Il ne vous reste plus qu'à ajouter d'autes épisodes si vous le souhaitez en recomançant la manoeuvre!

Maintenant il faudrait créer le flux non? Utilisez simplement la commande dans le même dossier que information.md :

castbuilder render

Vous trouverez votre site web et votre flux RSS dans le dossiet output/ généré à ce moment! Plus qu'à copier tout ce contenu et à le mettre sur votre hébergement Web!

Il est aussi possible de créer des auteurs, plus d'informations dans le Wiki!