Communitygithub.com

imswarnil/Personal-Website-Jekyll-Theme

Créez un site personnel avec ce thème Jekyll — blog, portfolio, vidéos, séries web, cours, podcast, newsletter, voyage, matériel et CV — et déployez-le sur GitHub Pages à l'adresse username.github.io. À utiliser quand quelqu'un veut son propre site à partir de ce dépôt, ajouter ou remodeler une collection, modifier la composition d'une page d'entrée, ou le déployer pour la première fois.

Qu'est-ce que Personal-Website-Jekyll-Theme ?

Ce thème Jekyll est conçu pour être configuré via les données plutôt que par la modification de templates. Il permet de créer rapidement un site personnel complet (blog, portfolio, vidéos, cours, podcast, newsletter, etc.) et de le déployer sur GitHub Pages. L'approche originale du thème repose sur un assistant de configuration en ligne de commande (`npm run setup`) qui écrit le fichier `_config.yml` et sauvegarde l'ancienne configuration. La personnalisation des pages d'entrée (ajout/suppression de sections comme le fil d'Ariane, le contenu principal, les tags, les commentaires, etc.) se fait en modifiant les listes `parts` et `widgets` dans la configuration des collections, sans jamais éditer de layout. Le thème inclut également un design system cohérent basé sur des propriétés CSS personnalisées (`--im-*`), une génération automatique de pages par tag, et plusieurs designs de cartes prêts à l'emploi. Il fonctionne avec Ruby 3.4 et est optimisé pour un déploiement via GitHub Actions.

Compatible avec~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/imswarnil/Personal-Website-Jekyll-Theme/tree/HEAD/.claude/skills/personal-site

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Créez un site personnel avec ce thème

Ce thème est composé à partir des données, et non de templates. Presque toutes les modifications demandées consistent à modifier _config.yml et à ajouter un fichier dans un dossier — si vous envisagez de modifier un layout, consultez d'abord ce document, car le point d'accroche dont vous avez besoin existe probablement déjà.

1. Le chemin le plus rapide : l'assistant de configuration

npm run setup          # ouvre un formulaire local, écrit _config.yml, sauvegarde l'ancienne config

Il se lie uniquement à 127.0.0.1, n'envoie jamais rien, et copie tout ce qu'il remplace d'abord dans .imprint-backup/<timestamp>/. Il pré-remplit à partir de la configuration actuelle, donc il peut être relancé sans risque.

L'assistant couvre l'identité, la couleur d'accent, l'en-tête et le pied de page, la navigation, les liens sociaux, les collections, les publicités, les analytics, le point de terminaison de la newsletter et le domaine. Il ne couvre délibérément pas la composition des pages par collection — il conserve ces clés inchangées (voir §4).

Ensuite :

npm run dev            # http://localhost:4000
npm run check          # diagnostic + construction de production

2. Déploiement sur username.github.io

  1. Créez un dépôt nommé exactement username.github.io (une page utilisateur), ou n'importe quel nom pour une page projet.
  2. Poussez cette arborescence sur main.
  3. Paramètres → Pages → Source : GitHub Actions.

.github/workflows/jekyll.yml construit avec Ruby 3.4 et déploie _site/. Il passe --baseurl "${{ steps.pages.outputs.base_path }}", donc le même workflow est correct pour une page utilisateur (chemin de base vide) et une page projet (/nom-du-depot/) — ne codez pas baseurl en dur.

CNAME contient le domaine personnalisé. Pas de domaine personnalisé → supprimez le fichier ; l'assistant le fait pour vous lorsque vous laissez le domaine vide.

3. Ajouter une collection

Une collection est un type de contenu : un blog, un portfolio, un podcast, une étagère de matériel. Ajoutez-en une dans _config.yml sous collections: :

  recettes:
    output: true
    title: Recettes
    singular: Recette
    description: "Une ligne à propos de cette collection."
    permalink: /recettes/:name/
    landing: /recettes/
    icon: cooking-pot          # n'importe quel nom de phosphoricons.com
    schema: Recipe             # type schema.org, pour JSON-LD
    card: blog                 # quel design de carte (voir §5)
    hero: { pattern: dots }    # la bannière de la page d'accueil de la collection ; `hero: false` pour l'en-tête compact
    image: "/assets/img/covers/recettes.svg"
    single:                    # composition d'une page d'entrée (voir §4)
      lead: cover
      parts: [breadcrumbs, head, lead, prose, tags, share, ask, author, nav]
      widgets: [toc, collection, about]

Ensuite :

mkdir _recettes                       # le dossier que Jekyll lit
# une page d'accueil qui liste la collection :
printf -- '---\nlayout: page\ntitle: Recettes\npermalink: /recettes/\nlist_collection: recettes\n---\n' > recettes.html
npm run thumbs                       # génère l'illustration de couverture pour la nouvelle collection

npm run doctor vous indiquera si vous avez oublié l'une de ces étapes.

Le thème en fournit treize : posts, portfolio, videos, snippets, prompts, webseries + episodes, courses + lessons, podcast, newsletter, travel, uses. Une collection enfant (un épisode, une leçon) appartient à son parent via un slug dans le front matter — series: ou course:.

4. Modifier la composition d'une page d'entrée

C'est la partie pour laquelle on pense souvent qu'un nouveau layout est nécessaire. Ce n'est pas le cas.

    single:
      lead: portfolio                 # _includes/leads/portfolio.html
      parts: [breadcrumbs, head, lead, prose, tags, share, ask, comments, author, nav]
      widgets: [details, toc, collection, cta]
      sidebar: true
  • parts → _includes/single/<nom>.html, empilés dans l'ordre donné
  • widgets → _includes/widgets/<nom>.html, dans la barre latérale
  • lead → _includes/leads/<nom>.html (none pour pas de lead)

Créez une partie en déposant un fichier et en le nommant. Aucun layout n'est modifié. N'importe quelle entrée peut remplacer ces trois éléments dans son propre front matter.

Parties fournies : breadcrumbs head toc-mobile lead prose tags share ask comments author nav episodes lessons siblings. Widgets : toc details collection about cta share subscribe ad. Leads : cover video prompt snippet portfolio series audio.

5. Designs de cartes

card: <nom> sur une collection sélectionne _includes/cards/<nom>.html. Fournis : blog (éditorial), portfolio (carte de dépôt), video (lecteur), snippet (fenêtre de code), prompt (fenêtre de chat), webseries (affiche portrait), episode, course, lesson, podcast, issue, trip, product. Non défini → valeur par défaut blog, donc une nouvelle collection a un aspect correct avant même d'avoir son propre design.

Les cartes dans une ligne de grille ont toujours la même hauteur. .im-cards étire chaque élément et le corps de la carte prend le mou — donc une nouvelle carte doit seulement mettre flex: 1 sur son corps et margin-top: auto sur son pied.

6. Pages de tags

_plugins/tag_pages.rb écrit une page par tag dans /tags/<slug>/, pour toutes les collections — le site.tags de Jekyll ne voit que les articles, ce qui sur un site qui tagge aussi des films et du matériel n'afficherait qu'un tiers de ce qui porte le tag. Les tags sont regroupés par slug, donc Analytics et analytics forment un seul sujet.

Un générateur _plugins/ s'exécute à chaque invocation de Jekyll par nos soins, ce que fait .github/workflows/jekyll.yml. Il ne s'exécuterait pas sous le mode Pages "construire à partir d'une branche" de GitHub ; là, définissez tag_pages: false et les liens de tag reviennent à des ancres sur /tags/.

7. Charte graphique — à lire avant d'écrire du CSS

Le thème suit l'Im Design System, et il a exactement deux interactions :

  • SURVOL — l'élément se REMPLIT (--im-hover-bg). Rien n'affine une bordure, rien ne grandit de trois pour cent, rien ne repose sur une ombre portée.
  • ACTIF — "vous êtes ici" : un remplissage plus fort et un libellé plus gras (--im-current-bg/-fg/-weight). Ce n'est jamais un changement de couleur.

L'accent est utilisé pour le bouton principal, le survol d'un lien, l'anneau de focus, la sélection, et la teinte dérivée de chaque collection — rien d'autre. Un bouton rempli et une carte se soulèvent exactement d'un pixel et projettent un trait fin.

Tout est une propriété personnalisée --im-* ; rien n'est une couleur littérale. _sass/im/abstracts/_mixins.scss contient les deux interactions, écrites une seule fois.

8. Les commandes

npm run setup     # le formulaire de configuration dans le navigateur
npm run dev       # serveur local + rechargement automatique
npm run build     # construction de production dans _site/
npm run new       # générer une entrée dans n'importe quelle collection
npm run thumbs    # (re)générer l'illustration de couverture à partir de la couleur d'accent
npm run doctor    # vérifier la configuration pour les erreurs qui cassent la construction
npm run test      # la suite de tests de configuration/assistant
npm run check     # doctor + build, c'est-à-dire ce que fait l'IC

Ruby 3.4 est requis (.ruby-version) ; le Ruby système macOS 2.6 ne peut pas construire ce site. bin/serve et bin/build forcent la bonne chaîne d'outils dans le PATH.

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

Skills associés