varia/varia.website
13
2
Fork 3
Code Issues 5 Pull Requests Releases Activity

added a bit of information to the readme on pelican and the plugins folders

Browse Source
This commit is contained in:
mb 2018-12-18 13:36:08 +01:00
parent 6202179334
commit c2b037149d
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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`