theolem/fel_website
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

completed tuto with pelican[Markdown] instructions

Browse Source
This commit is contained in:
theo1 2020-05-19 14:58:54 +02:00
parent 3204fa2656
commit 0c96120724
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
pelican_git_tuto.md
View File

@ -51,13 +51,15 @@ Comme dit plus haut, votre site web Pelican tient dans un dossier, avec une arch
### 3. Comment je me le procure ? ### 3. Comment je me le procure ?
Pour commencer avec Pelican, il faut commencer par [l'installer](https://docs.getpelican.com/en/stable/install.html). Comme précisé sur ce lien, le plus simple est d'installer Python et Pip. Voici quelques liens [pour Windows](https://matthewhorne.me/how-to-install-python-and-pip-on-windows-10/), [pour Mac](https://ahmadawais.com/install-pip-macos-os-x-python/), et pour Linux c'est trop facile, tu trouveras tout⋅e seul⋅e ^^ Pour commencer avec Pelican, il faut commencer par [l'installer](https://docs.getpelican.com/en/stable/install.html). Comme Pelican est écrit en Python, il est d'installer `python` (l'_interpréteur_ Python) et `pip` (le gestionnaire de paquets de Python, qui permet d'installer des centaines de modules différents). Voici quelques liens [pour Windows](https://matthewhorne.me/how-to-install-python-and-pip-on-windows-10/), [pour Mac](https://ahmadawais.com/install-pip-macos-os-x-python/), et pour Linux c'est trop facile, tu trouveras tout⋅e seul⋅e ^^
_Attention, apparement Pelican nécessite d'installer Python3. Si vous installez Python2, vous risquez d'avoir des problêmes._ _Attention, Pelican nécessite à présent d'installer python3, et le gestionnaire de paquet qui va avec, pip3._
Maintenant que tu as Python et Pip, il faut installer Pelican ( [ici](https://docs.getpelican.com/en/stable/install.html) je te dis). Il est conseillé d'installer **pelican[Markdown]**, on verra pourquoi ensuite. Une fois que c'est fait, vérifier en ouvrant un terminal qu'on a accès aux commandes **pelican** et **pelican content** (les taper sur le terminal, faire entrer, et s'assurer qu'il se passe quelque chose qui ne ressemble pas à « command not found »). Maintenant que tu as Python et Pip, il faut installer Pelican ( [ici](https://docs.getpelican.com/en/stable/install.html) je te dis). Il est aussi nécessaire le packets Markdown pour pouvoir rédiger du contenu dans ce langage. Pour celà, il faut lancer la commande `pip3 install pelican[Markdown]`, qui ira chercher les bons paquets (une fois `pip3 `correctement installé).
Pour finir, on va commencer notre projet de site : se déplacer dans un nouveau dossier avec le terminal ([tuto pour mac](https://macpaw.com/fr/how-to/use-terminal-on-mac)), et exécuter la commande **pelican-quickstart**. Il y aura ensuite une série de questions à répondre, dans le doute répondre » Non ». _Note : si tu as déjà un projet Pélican sur lequel tu veux travailler, saute ce dernier paragraphe_. Une fois que c'est fait, vérifier en ouvrant un terminal qu'on a accès aux commandes `pelican` et `pelican content` (les taper sur le terminal, faire entrer, et s'assurer qu'il se passe quelque chose qui ne ressemble pas à « command not found »).
Pour finir, on va commencer notre projet de site : se déplacer dans un nouveau dossier avec le terminal ([tuto pour mac](https://macpaw.com/fr/how-to/use-terminal-on-mac)), et exécuter la commande `pelican-quickstart`. Il y aura ensuite une série de questions à répondre, dans le doute répondre » Non ». _Note : si tu as déjà un projet Pélican sur lequel tu veux travailler, saute ce dernier paragraphe_.
Maintenant, les dossiers décrits ci-dessus devraient apparaître (à l'exception de themes/ et des sous-dossiers de content/, qu'on créera plus tard). Maintenant, les dossiers décrits ci-dessus devraient apparaître (à l'exception de themes/ et des sous-dossiers de content/, qu'on créera plus tard).
@ -74,13 +76,16 @@ Voici un exemple d'à quoi peut ressembler un fichier markdown.
## Première sous partie ## Première sous partie
Ceci est du contenu, que je peux mettre **en gras**, _en italique_. Ceci est du contenu, que je peux mettre **en gras**, _en italique_.
Je peux également écrire `du code préformaté`, et si j'ai besoin d'une citation :
> je l'indique comme ça.
## Deuxième sous partie ## Deuxième sous partie
Je peux également insérer des [hyperliens](isitmonday.today), voir des émojis :thinking:. Je peux également insérer des [hyperliens](isitmonday.today), voir des émojis :thinking:.
``` ```
Plutôt facile à lire non ? Plutôt facile à lire non ? Plus que du HTML en tout cas[^1].
Voici donc la première facette de Pelican : le contenu. Il sera placé dans le dossier `content`, dans des fichiers `monfichier.md`. Voici donc la première facette de Pelican : le contenu. Il sera placé dans le dossier `content`, dans des fichiers `monfichier.md`.
@ -332,3 +337,7 @@ Plusieurs étapes :
On a simplement effleuré toutes les possibilités de git. Il est possible d'avoir plusieurs versions du code alternatives en parallèle, de régler automatiquement les conflits de version, de nettoyer l'historique de version pour ne garder que des messages de commit clairs, de modifier un message de commit précédent, de rajouter un fichier qu'on avait oublié d'ajouter sur le commit précédent... et tellement plus encore. On a simplement effleuré toutes les possibilités de git. Il est possible d'avoir plusieurs versions du code alternatives en parallèle, de régler automatiquement les conflits de version, de nettoyer l'historique de version pour ne garder que des messages de commit clairs, de modifier un message de commit précédent, de rajouter un fichier qu'on avait oublié d'ajouter sur le commit précédent... et tellement plus encore.
Mais pour ça, il y a un milliard de tutos sur le net mondial ! Mais pour ça, il y a un milliard de tutos sur le net mondial !
[^1]: il faut aussi noter que le HTML est un sous-ensemble du Markdown, c'est à dire que si vous insérez du code HTML directement dans le Markdown, ce sera accepté par les éditeurs. C'est parfois nécessaire, par exemple lorsque l'on veut mettre en page un texte d'une autre manière que celle qui est automatiquement générée par le générateur.