doc-site |

🇺🇸 English (US) friendly

Bienvenue sur doc-site, un template Jekyll conçu pour générer un site de documenation de solutions logicielles. Deux proposions:

1. Double option de déploiement :
   • GitHub Pages : Idéal pour les projets open-source. https://dsissoko.github.io/doc-site/
   • Netlify : Parfait pour les projets privés (le plan gratuit prend en charge les dépôts privés). https://docsite-demo.netlify.app/
2. Une méthode de documentation de vos solutions logicielles basée sur C4 model

🚀 Pour utiliser ce projet, nous vous recommandons d'utiliser la fonction GitHub "Use this template" afin de créer rapidement votre propre dépôt basé sur ce modèle.

Ce template repose sur le thème Just the Docs, qui offre une expérience fluide et moderne pour organiser et présenter vos contenus.

✨ Personnalisations incluses

• voir le _config.yml
• Support de Mermaid 11.4.1 pour vos diagrammes et schémas.

---

🚀 Fonctionnalités

• Jekyll : Un générateur de site statique performant et flexible.
• Déploiement optimisé : GitHub Pages pour les projets publics, Netlify pour les projets privés.
• Déploiement conditionnel : Pour éviter un failed de l'action github de déploiement quand les GITHUB pages ne sont pas activées, vous pouvez positionner une variable pour les actions PAGES_ENABLED à false dans les settings de votre projet.
• Organisation simplifiée : Tout le contenu est centralisé dans docs/ pour une gestion fluide.
• Thème Just the Docs : Navigation intuitive, recherche intégrée et mise en page responsive.

---

📁 Structure du Dépôt

• docs/ : Contient l’intégralité du site (pages, layouts, assets, etc.).
• README.md : Ce fichier, qui détaille le fonctionnement du template et les options de déploiement.
• Autres fichiers de configuration et documentation.

---

🚀 Déploiement

▶️ GitHub Pages (Projets Publics)

1. Créez un dépôt en partant de ce template via "Use this template".
2. Activez GitHub Pages dans les paramètres du dépôt (l'action de déploiement est déjà configurée dans .github/workflows). L'action GITHUB échouera tant que nous n'avez pas activé les pages ou que vous n’avez pas positionnée une variable PAGES_ENABLED à false
3. Profitez du site : Le déploiement s'effectue automatiquement.

🔒 Netlify (Projets Privés)

1. Connectez votre dépôt à Netlify.
2. Définissez docs/ comme répertoire de publication lors de la configuration.
3. Déployez et laissez Netlify s’occuper du reste !

---

📖 Démarrer avec Just the Docs

Le template inclut le thème Just the Docs, idéal pour structurer votre documentation.

🔹 Premiers pas :

1. Consultez la documentation officielle pour explorer toutes les options de personnalisation.
2. Adaptez le contenu du répertoire docs/ selon vos besoins.
3. Expérimentez la navigation et les options disponibles pour optimiser votre documentation.

---

💻 Développement Local

Envie de tester avant de déployer ? Voici comment lancer le site en local :

1. Installez Ruby et Bundler.

2. Dans le dossier docs/, installez les dépendances :

   bundle install

3. Lancez Jekyll pour voir le site en local :

   bundle exec jekyll serve

4. Accédez à http://localhost:4000 pour voir le rendu.

🔗 Démarrer avec C4 model

• Visualising software architecture with the C4 model

---

🤝 Contribuer

Toutes les contributions sont les bienvenues !
Si vous avez des suggestions ou des améliorations, n’hésitez pas à soumettre une issue ou une pull request.

---

📜 Licence

© 2024-2025 David Sissoko. Distribué sous licence MIT.

🎯 Badges