Un site pour la promotion de catium - retour accueil
git clone git://bebou.netlib.re/site-catium
Log | Files | Refs | README |
index.sh (4373B)
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)
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
27 Afin de satisfaire ces propriétés la version canonique de catium offre très
28 peu de fonctionnalités. Elle propose plutôt une implémentation très simple d'un
29 système de templating en shell POSIX depuis lequel artisanalement construire son
30 site. Les contributeurs à l'outil disent parfois de catium qu'il est davantage
31 un "échafaudage intellectuel" qu'un logiciel ou framework aux contours bien
32 définis.
33
34 En ce sens la plupart des sites construit avec catium l'étendent pour y
35 inclure de nouvelles fonctionnalités au gré de leurs besoins. Pour trouver des
36 exemples jetez un coup d'œil à la [galerie](#galerie). Vous pouvez copier-coller
37 du code que vous y trouverez ou, mieux encore, prendre contact avec la ou les
38 personnes derrière un site qui vous plait pour échanger sur la façon dont
39 catium pourrait vous être utile !
40
41 ## Se lancer
42
43 Pour générer le site par défaut de catium vous devez télécharger le code :
44
45 $ git clone git://bebou.netlib.re/catium
46
47 et construire le site :
48
49 $ make
50 chmod +x contents/index.sh
51 mkdir -p public; contents/index.sh > public/index.html
52 ----------------------------
53 Première exécution de catium, merci d'aller modifier le code juste en dessous
54 de ce paragraphe dans le fichier "page". Cela vous permettra de choisir un ou
55 plusieurs transcripteurs pour votre site. Si une ou plusieurs des lignes déjà
56 présentes vous conviennent vous pouvez la ou les décommenter en retirant le "#"
57 devant. Vous pouvez ensuite supprimer ce bloc de code et relancer make :)
58 ----------------------------
59 Compris ? [y/n]
60
61 Lisez bien le message.
62 Si vous insérez `y` vous serez inviter à faire les modifications sinon vous
63 serez invité·e à contacter katzele@framalistes.org.
64 Quoi qu'il arrive vous verrez ensuite ces erreurs, vous pouvez les ignorer :
65
66 Bonne édition :)
67 #ou
68 Contacter katzele@framalistes.org pour des explications
69
70 make: *** [makefile:69 : public/index.html] Erreur 1
71 make: *** Suppression du fichier « public/index.html »
72
73 Ouvrez le script page et, comme indiqué, supprimez le code entre :
74
75 #################
76 # SUPPRIMEZ DE LA
77
78 et
79
80 # A DE LA
81 #########
82
83 puis juste en dessous choisissez (ou écrivez) l'une des fonctions `show` en
84 fonction de ce en quoi vous voulez écrire le site. Par exemple, si vous voulez
85 écrire les pages en markdown vous pouvez décommenter la ligne `show() lowdown
86 "$tmpdir/$1"`. Il vous faudra évidemment avoir installé `lowdown` pour que tout
87 fonctionne.
88
89 Il vous reste à relancer la construction du site :
90
91 $ make
92 chmod +x contents/index.sh
93 contents/index.sh > public/index.html
94 cp contents/favicon.png public/favicon.png
95 cp contents/style.css public/style.css
96
97 Le résultat se trouvera dans le dossier `public` ! :)
98
99 ## Galerie
100
101 endsection
102
103 cat db/galerie.tsv |
104 tsv2anything ./layouts/galerie |
105 save main
106
107 section: main
108
109 ## Documentation
110
111 [Pour savoir d'où vient catium et les questions que l'on se pose sur ses frontières](documentation/histoire.html)
112
113 [Explication complète du code de catium](documentation/construire.html)
114
115 [Guide sur l'utilisation de catium et des modifications élémentaires](documentation/usage.html)
116
117 Pour des exemples de sites existant utilisant catium voir [la galerie](/#galerie).
118
119 [^1]: https://fr.wikipedia.org/wiki/Francium#cite_ref-chemeducator_7-4