doc-site |

Template Jekyll moderne pour générer un site de documentation technique, clé en main pour vos projets open source ou privés.

🚀 Pourquoi adopter doc-site ?

✅ Déploiement instantané sur GitHub Pages OU Netlify
✅ Structure prête pour documenter vos solutions en suivant le C4 model
✅ Basé sur le thème Just the Docs (pro, responsive, recherche intégrée)

Projet documenté en 🇫🇷 par défaut.
Une version anglaise auto-traduite est disponible ici :

👉 English (auto-translated by Google)

---

📋 Fonctionnalités clés

• ✅ Déploiement instantané sur GitHub Pages (public, OSS-friendly) ou Netlify (idéal pour les dépôts privés)
• ✅ Organisation simple : tout le contenu dans docs/
• ✅ Thème Just the Docs : navigation latérale, recherche intégrée, responsive
• ✅ Support natif de Mermaid pour vos diagrammes et schémas
• ✅ Documentation C4 model-ready : modélisez vos architectures (C4 model)
• ✅ Personnalisation facile : éditez docs/_config.yml pour adapter le thème ou la navigation (toutes les options Just the Docs sont supportées)

---

⚡ Démarrage express

1️⃣ Créez votre site depuis ce template

• Cliquez sur Use this template pour générer votre repo en 2 clics

⚡ Déploiement automatisé prêt à l'emploi !

Ce template inclut déjà un workflow GitHub Actions (.github/workflows/jekyll.yml) pour builder et publier automatiquement votre documentation sur GitHub Pages à chaque commit dans le dossier docs/.

Vous pouvez désactiver le déploiement GitHub Pages en positionnant la variable PAGES_ENABLED=false dans les Settings → Variables du dépôt.

2️⃣ Déployez… selon votre besoin

▶️ Sur GitHub Pages (public OSS)

• Activez GitHub Pages dans les Settings du repo
• Le workflow .github/workflows est déjà configuré
• Si GitHub Pages n’est pas activé :
  • Positionnez la variable PAGES_ENABLED à false pour éviter le fail de l’action
• Sinon, à chaque nouveau commit, le site sera publié sur
  • https://<votre-user>.github.io/<votre-repo>/
  • Exemple pour ce dépôt : https://dsissoko.github.io/doc-site/

🔒 Sur Netlify (projet privé ou public)

• Connectez votre dépôt GITHUB à Netlify
• Définissez docs/ comme répertoire de publication
• Déployez, c’est fait : chaque nouveau commit sera déployé sur le site
  • Exemple pour ce dépôt : https://docsite-demo.netlify.app/

---

💻 Développement local

Prérequis

• Ruby + Bundler
• OS Linux/Mac/WSL conseillé pour dev local

Setup

# Installez Ruby via RVM (ou autre)
gpg --keyserver keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable
source ~/.rvm/scripts/rvm
rvm install 3.2.2

# Dans docs/, installez les dépendances
cd docs
bundle install

# Lancez le serveur Jekyll local avec live reload
bundle exec jekyll serve --livereload

🖥️ Le site est accessible sur http://localhost:4000
Modifiez le contenu, ajoutez des pages dans docs/, rafraîchissez pour voir le résultat !

---

🎯 Badges

---

📫 Maintenu par @dsissoko – suggestions et étoiles appréciées !