Un site pour la promotion de catium - retour accueil
git clone git://bebou.netlib.re/site-catium
Log | Files | Refs | README |
index.sh (4657B)
1 #! /usr/bin/env ./page
2 title: Catium
3 author: Arthur Pons
4 description: "Catium est un générateur de site statique mettant l'accent sur la simplicité, l'interopérabilité et la portabilité"
5
6 section: main
7
8 Un générateur de site statique. *catium* était le nom qu'aurait choisi
9 [Marguerite Perey](https://fr.wikipedia.org/wiki/Marguerite_Perey) pour nommer
10 l'élément chimique [francium](https://fr.wikipedia.org/wiki/Francium) qu'elle
11 venait de découvrir si Irène Joliot-Curie ne l'en avait pas dissuadé parce que
12 ça ressemblait trop à "chat" en anglais[^1]. Un jeu de mot autour du logiciel
13 `cat` ou de `katzele` n'est sûrement pas loin.
14
15 ## Philosophie
16
17 catium est un logiciel ayant pour ambition :
18
19 * d'être petit et simple
20 * de faire peu de suppositions sur vos besoins
21 * d'être portable (testé sur Linux, *BSD et MacOs, avec dash, zsh, bash et ksh)
22 * de ne nécessiter que les dépendances dont *vous* avez besoin
23 * de vous laisser écrire dans le·s langage·s de markup de votre choix
24 * d'être aussi extensible que possible
25 * d'être sobre en ressource
26 * d'être durable dans le temps même avec peu maintenance
27
28 Afin de satisfaire ces propriétés la version canonique de catium offre très
29 peu de fonctionnalités. Elle propose plutôt une implémentation très simple d'un
30 système de templating en shell POSIX depuis lequel artisanalement construire son
31 site. Les contributeurs à l'outil disent parfois de catium qu'il est davantage
32 un "échafaudage intellectuel" qu'un logiciel ou framework aux contours bien
33 définis.
34
35 En ce sens la plupart des sites construits avec catium l'étendent pour y
36 inclure de nouvelles fonctionnalités au gré de leurs besoins. Pour trouver des
37 exemples jetez un coup d'œil à la [galerie](#galerie). Vous pouvez copier-coller
38 du code que vous y trouverez ou, mieux encore, prendre contact avec la ou les
39 personnes derrière un site qui vous plait pour échanger sur la façon dont
40 catium pourrait vous être utile !
41
42 ## Se lancer
43
44 Pour générer le site par défaut de catium vous devez télécharger le code via le
45 dépôt git :
46
47 $ git clone git://bebou.netlib.re/catium
48
49 ou en téléchargeant un tarball de la dernière version :
50
51 $ mkdir catium
52 $ curl -Ls http://catium.bebou.netlib.re/catium.tar > catium.tar
53 $ tar xvf catium.tar
54
55 et construire le site :
56
57 $ make
58 chmod +x contents/index.sh
59 mkdir -p public; contents/index.sh > public/index.html
60 ----------------------------
61 Première exécution de catium, merci d'aller modifier le code juste en dessous
62 de ce paragraphe dans le fichier "page". Cela vous permettra de choisir un ou
63 plusieurs transcripteurs pour votre site. Si une ou plusieurs des lignes déjà
64 présentes vous conviennent vous pouvez la ou les décommenter en retirant le "#"
65 devant. Vous pouvez ensuite supprimer ce bloc de code et relancer make :)
66 ----------------------------
67 Compris ? [y/n]
68
69 Lisez bien le message.
70 Si vous insérez `y` vous serez inviter à faire les modifications sinon vous
71 serez invité·e à contacter katzele@framalistes.org.
72 Quoi qu'il arrive vous verrez ensuite ces erreurs, vous pouvez les ignorer :
73
74 Bonne édition :)
75 #ou
76 Contacter katzele@framalistes.org pour des explications
77
78 make: *** [makefile:69 : public/index.html] Erreur 1
79 make: *** Suppression du fichier « public/index.html »
80
81 Ouvrez le script page et, comme indiqué, supprimez le code entre :
82
83 #################
84 # SUPPRIMEZ DE LA
85
86 et
87
88 # A DE LA
89 #########
90
91 puis juste en dessous choisissez (ou écrivez) l'une des fonctions `show` en
92 fonction de ce en quoi vous voulez écrire le site. Par exemple, si vous voulez
93 écrire les pages en markdown vous pouvez décommenter la ligne `show() lowdown
94 "$tmpdir/$1"`. Il vous faudra évidemment avoir installé `lowdown` pour que tout
95 fonctionne.
96
97 Il vous reste à relancer la construction du site :
98
99 $ make
100 chmod +x contents/index.sh
101 contents/index.sh > public/index.html
102 cp contents/favicon.png public/favicon.png
103 cp contents/style.css public/style.css
104
105 Le résultat se trouvera dans le dossier `public` ! :)
106
107 ## Galerie
108
109 endsection
110
111 cat db/galerie.tsv |
112 tsv2anything ./layouts/galerie |
113 save main
114
115 section: main
116
117 ## Documentation
118
119 [Pour savoir d'où vient catium et les questions que l'on se pose sur ses frontières](documentation/histoire.html)
120
121 [Explication complète du code de catium](documentation/construire.html)
122
123 [Guide sur l'utilisation de catium et des modifications élémentaires](documentation/usage.html)
124
125 Pour des exemples de sites existant utilisant catium voir [la galerie](/#galerie).
126
127 [^1]: https://fr.wikipedia.org/wiki/Francium#cite_ref-chemeducator_7-4