l_atelier:geekdoc

Ceci est une ancienne révision du document !


Hugo est un générateur de site statique rapide et flexible, tandis que Geekdoc est un thème spécialement conçu pour la documentation technique. Ensemble, ils offrent de nombreux avantages pour la création de sites de documentation.
Vu que je propose gratuitement quelques services à mon entourage, j'ai migré de geekdoc vers dokuwiki

Pourquoi geekdoc ?

D’une part, Geekdoc offre une structure de navigation claire et organisée, ce qui permet aux utilisateurs de trouver rapidement les informations dont ils ont besoin, mais égallement Geekdoc s’appuie sur Hugo, ce qui lui permet hériter des features suivantes :

  • Support du multi-langes
  • customisation de fonction grace au shortcodes d’hugo.
  • Generation des pages ultra rapide

Mais surtout grace à hugo, il est possible d’avoir un site de documentation statisque (pas besoin de serveur PHP ou Node.js)

Installation

L’installation de Geekdoc utilisera le trio nix, direnv, just. Ce trio permet d’installer automatiquement un environement de developpement ainsi qu’il facilite la contribution à un projet sans devoir installer les outils nécéssaire pour y ontribuer.

Donc pour installer et configurer Geekdoc, commencer par installer le trio nix, direnv, just](/onboarding/nix-direnv-just).

Ensuite récupérer et configurer le template hugo-geekdoc avec les commandes uivantes

nix flake new -t "github:badele/nix-projects#hugo-geekdoc" geekdoc
cd geekdoc
nix develop
sh init_project

démo

demo geekdoc

geekdoc.tape
# Output format
Output geekdoc.gif
 
Require nix
 
Set Shell "bash"
Set FontSize 18
Set Width 800
Set Height 680
 
###############################################################################
# Init project
###############################################################################
 
Type "cd /tmp ; nix flake new -t 'github:badele/nix-projects#hugo-geekdoc' devops.jesuislibre.org" Sleep 500ms  Enter
 
Type "cd /tmp/devops.jesuislibre.org" Sleep 500ms  Enter
 
Type "nix develop" Sleep 500ms  Enter  Sleep 4s 
 
Type "sh init_project" Sleep 500ms  Enter Sleep  1s
 
Type "github.com" Sleep 500ms  Enter Sleep 1s
 
Type "badele" Sleep 500ms  Enter Sleep 1s
 
Type "devops.jesuislibre.org" Sleep 500ms  Enter Sleep 1s
 
Type "https://devops.jesuislibre.org" Sleep 500ms  Enter Sleep 1s
 
Type "JSL Devops" Sleep 500ms  Enter Sleep 1s
 
###############################################################################
# Init project
###############################################################################
 
Type "git remote add origin git@github.com:badele/devops.jesuislibre.org.git" Sleep 500ms  Enter Sleep 1s
Type "git commit -m 'feat: init project'" Sleep 500ms  Enter Sleep 3s
Type "git push -u origin main" Sleep 500ms  Enter Sleep 3s
 
Sleep 5s
    • openai
      • Reformulation des phrases
      • Correction des fautes d’orthographes
  • l_atelier/geekdoc.1760164620.txt.gz
  • Dernière modification : 2025/10/11 06:37
  • de badele