{"id":19141773,"url":"https://github.com/3olen/github-pages-skeleton","last_synced_at":"2026-06-11T21:35:23.010Z","repository":{"id":209508687,"uuid":"724118056","full_name":"3OLEN/github-pages-skeleton","owner":"3OLEN","description":"Template de base pour les solutions \"GitHub Pages\" au sein de la promotion 3OLEN.","archived":false,"fork":false,"pushed_at":"2025-04-02T14:16:37.000Z","size":108,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T15:22:28.864Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3OLEN.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-27T12:40:22.000Z","updated_at":"2025-04-02T14:16:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"436af2bc-44a1-4617-8303-9207863c8f30","html_url":"https://github.com/3OLEN/github-pages-skeleton","commit_stats":null,"previous_names":["3olen/github-pages-skeleton"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/3OLEN/github-pages-skeleton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3OLEN%2Fgithub-pages-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3OLEN%2Fgithub-pages-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3OLEN%2Fgithub-pages-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3OLEN%2Fgithub-pages-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3OLEN","download_url":"https://codeload.github.com/3OLEN/github-pages-skeleton/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3OLEN%2Fgithub-pages-skeleton/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34219510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T07:24:42.340Z","updated_at":"2026-06-11T21:35:23.005Z","avatar_url":"https://github.com/3OLEN.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 3OLEN - GitHub Pages Skeleton\n\nModèle de base pour l'utilisation de GitHub Pages dans le cadre de sujets pour les\n\u003cabbr title=\"ORT LYON Enseignement Numérique\"\u003e3OLEN\u003c/abbr\u003e.\n\n## 📦️ Composants\n\n- Utilisation des dépendances supportées par [GitHub Pages](https://pages.github.com/versions/).\n  - [Jekyll](https://jekyllrb.com/) v3.9\u003cbr\u003e\n    *Pour utiliser une version plus récente, il est nécessaire de définir une `GitHub Action` spécifique.*\n  - [Minima](https://github.com/jekyll/minima) v2.5 (thème `light` + `dark` ; choix utilisateur via \"footer\")\n\n# 📤️ Récupération du modèle\n\n1. Récupération des sources depuis le dépôt GitHub : téléchargement des sources ou `git clone`.\n2. Suppression du `.git` (si récupération par `git clone`).\n3. Initialisation d'un nouveau dépôt Git : `git init --initial-branch main`.\n4. Adaptation des fichiers pour le nouveau projet ; [Procédure détaillée](#-adaptions-des-fichiers).\n5. Définition du dépôt GitHub : `git remote add origin \u003curl_repository\u003e`.\n6. `git add . \u0026\u0026 git commit -m \"🎉 New GitHub Pages project\" \u0026\u0026 git push -u origin main`.\n\n## ♻️ Adaptions des fichiers\n\nPuisque les sources sont copiées, il est nécessaire d'adapter les différents fichiers pour la cohérence avec le nouveau\nprojet.\n\n### 🐋 Docker\n\nTout ce qui se trouve dans les dossiers `bin/dev` et `docker` est lié à l'utilisation de docker afin de définir le\nsite en local et pouvoir le concevoir et le tester sans avoir besoin d'installer l'environnement GitHub Pages sur la\nmachine ni de le déployer à chaque modification sur GitHub.\n\n#### « J'utilise Docker. »\n\nSi vous comptez utiliser Docker, il est nécessaire de modifier le fichier [_parameters](bin/dev/_parameters) et les\nvariables :\n- `DOCKER_IMAGE_NAME` : Nom de l'image Docker ; à modifier selon le nom du projet.\n- `DOCKER_CONTAINER_NAME` : Nom du container Docker ; n'est peut-être pas à modifier.\n\nLe détail de l'utilisation de Docker est défini à la section [Scripts Docker](#-scripts-utiles).\n\n#### « Je n'utilise pas Docker. »\n\nSi vous ne comptez pas utiliser Docker, vous pouvez supprimer ces dossiers.\n\nPour tester le site en local sans utiliser Docker, il sera nécessaire d'installer :\n- [Ruby](https://www.ruby-lang.org/fr/) [\u003e=2.5.0]\n- [RubyGems](https://rubygems.org/)\n- [Bundler](https://bundler.io/) (version 2.0 ou supérieure).\n\nPuis d'exécuter les mêmes commandes que celles définies dans le fichier [entrypoint](docker/jekyll/entrypoint).\n\nSource : [GitHub Pages - Testing your GitHub Pages site locally with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll)\n\n### 📝 README.md\n\nL'ensemble du contenu du fichier `README.md` est à supprimer et à réécrire selon le nouveau projet.\n\n### 🔧 Configuration\n\nLa configuration de Jekyll se trouve dans le fichier [_config.yaml](docs/_config.yaml) ; deux variables sont à\nmodifier :\n- `title` : titre du site/projet ; est utilisée dans le `\u003ctitle\u003e` HTML.\n- `description` : description du site/projet.\n\n### 🍱 Site\n\nLa page d'accueil ([index.html](docs/index.html)) reprend seulement la description du site/projet. Vous pouvez la\nmodifier avant le commit initial ou le faire plus tard.\n\n# Description et utilisation du modèle\n\n## 💻️ Développement local\n\nLes informations concernant le développement local (avec ou sans Docker) sont définies [plus haut](#-docker).\n\n### 🔨 Scripts utiles\n\n- `bin/dev/start`\n  - Initialise l'environnement Docker en créant l'image utilisée par le container.\n  - Crée un container en \"one-shot\" en se basant sur le `entrypoint`.\n- `bin/dev/build`\n  - Exécute la commande `jekyll build` (par le biais de `bundler`) dans le container Docker.\n  - Il est parfois nécessaire de forcer un *build* pour que les modifications soient prises en compte, notamment sur\n    la config, le style ou encore le templating dynamique.\n\n\n## 🧱 Contenu du site\n\n### 📄 Pages\n\nLes pages sont définies à la racine des sources du site (dossier `docs`) ou dans des sous-dossiers, selon la\nstructuration prévue. Ces pages doivent utiliser l'extension `.html` ou `.md`.\n\n\u003e ⚠️ Le Front Matter est obligatoire pour que ces fichiers soient pris en compte par Jekyll.\n\nLa configuration de l'IDE doit être adaptée pour pouvoir associer ces fichiers au langage `Liquid` pour la coloration\nsyntaxique et l'autocomplétion.\n\nLa suite « Jetbrains » possède un plugin `Liquid`.\n\n### 🍱 Templates réutilisables\n\nLes `_layouts` ou les `_includes` peuvent être définis en tant que fichier `.liquid` (ou `.html.liquid` / `.md.liquid`)\nafin d'utiliser la coloration syntaxique et l'autocomplétion pour `Liquid` de l'IDE.\n\n# You better work! 🎶\n\nIl ne reste plus qu'à vous mettre au travail et fournir un site \"statique\" selon vos besoins !\n\n## 🔗 liens utiles\n\n- [Documentation Jekyll](https://jekyllrb.com/docs/)\n- [Documentation Liquid](https://shopify.github.io/liquid/)\n- [Exemple du Projet 31](https://github.com/3OLEN/projet-31)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3olen%2Fgithub-pages-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3olen%2Fgithub-pages-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3olen%2Fgithub-pages-skeleton/lists"}