2018-02-01 13:55:35 +01:00
# Varia website
2017-09-13 12:19:56 +02:00
2018-01-19 12:57:45 +01:00
## Cloning
2018-02-01 20:17:10 +01:00
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:
2018-01-27 12:26:51 +01:00
2018-02-01 13:55:35 +01:00
`git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules`
2017-09-13 12:19:56 +02:00
2018-08-22 21:52:18 +02:00
## Install
$ pip3 install -r requirements.txt
## Start
You can make use of the makefile, for example by running the following command to start a python server:
$ make devserver
Visit the website at localhost:8000
2018-02-01 13:04:22 +01:00
## Update submodules
We are currently using two submodules:
2018-02-01 15:32:05 +01:00
* pelican-plugins ([https://github.com/getpelican/pelican-plugins](https://github.com/getpelican/pelican-plugins))
* plugins-custom ([https://git.vvvvvvaria.org/varia/plugins-custom](https://git.vvvvvvaria.org/varia/plugins-custom))
2018-02-01 13:04:22 +01:00
To update these submodules within your (already) cloned repository, first init the submodule, and then update it:
2018-03-07 10:37:06 +01:00
cd /path/to/submodule
2018-02-01 13:04:22 +01:00
git submodule init
git submodule update
2018-02-01 13:18:46 +01:00
2017-09-13 12:19:56 +02:00
## Posting Content
2018-08-22 21:52:18 +02:00
We're using Pelican to generate a static website. The main way to add content to the website is by making 'posts' in the folder `content` .
2017-09-13 12:19:56 +02:00
2018-08-22 21:52:18 +02:00
This can be done either locally or via the gitlab interface by creating a new file.
2017-09-13 12:19:56 +02:00
Make sure that each article contains at least the following at the top of the document:
Title: een nieuw initiatief
Date: 2017-07-07 18:32
Category: news
2018-08-22 21:52:18 +02:00
Tags: event, workshop
slug: the-name-of-the-html-page
lang: nl OR en
2017-09-13 12:19:56 +02:00
2018-08-22 21:52:18 +02:00
Articles are written in a markup language called markdown. [Here ](https://daringfireball.net/projects/markdown/syntax ) is an overview of the syntax. You can also use the online editor in gitlab to help you.
2017-09-13 12:19:56 +02:00
2018-08-22 21:52:18 +02:00
## Layout & theme
2017-09-13 12:19:56 +02:00
todo
2018-08-22 21:52:18 +02:00
## Editing templates
todo