From c2b037149dd4db10e58662b748dd400f3878d176 Mon Sep 17 00:00:00 2001 From: mb Date: Tue, 18 Dec 2018 13:36:08 +0100 Subject: [PATCH] added a bit of information to the readme on pelican and the plugins folders --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4b0615..22f9d29 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ # Varia website -## Cloning +## Pelican -The folder 'plugins' is linked to the Pelican project '[pelican-plugins](https://github.com/getpelican/pelican-plugins/)' repository. To clone both the varia.website and pelican-plugins repository, add the --recurse-submodules option in your git clone command: +The Varia website is made with Pelican, a static site generator written in Python. This means that the website is first generated on a computer (using Python, Jinja and Pelican) into a set of html pages, files and images. This set of documents is then uploaded to the server. + +One of the things that Pelican uses is *plugins*. They are used to add extra features to the generation process of the website. + +In this repository there is a folder called 'plugins' and another one called 'plugins-custom'. + +The first one, 'plugins' is linked to the offical collection of plugins from the Pelican project '[pelican-plugins](https://github.com/getpelican/pelican-plugins/)'. The 'plugins-custom' folder consists of plugins that we wrote ourself. + + +## Clone + +To clone both the varia.website and pelican-plugins repository, add the --recurse-submodules option in your git clone command: `git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules`