|
@ -1,6 +1,6 @@ |
|
|
# Varia website |
|
|
# Varia website |
|
|
|
|
|
|
|
|
> https://varia.zone/ |
|
|
> https://varia.zone |
|
|
|
|
|
|
|
|
## Pelican |
|
|
## Pelican |
|
|
|
|
|
|
|
@ -9,7 +9,7 @@ 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 |
|
|
Python, Jinja and Pelican) into a set of html pages, files and images. This set |
|
|
of documents is then uploaded to the server. |
|
|
of documents is then uploaded to the server. |
|
|
|
|
|
|
|
|
One of the things that Pelican uses is *plugins*. They are used to add extra |
|
|
One of the things that Pelican uses is _plugins_. They are used to add extra |
|
|
features to the generation process of the website. |
|
|
features to the generation process of the website. |
|
|
|
|
|
|
|
|
In this repository there is a folder called 'plugins' and another one called |
|
|
In this repository there is a folder called 'plugins' and another one called |
|
@ -24,27 +24,32 @@ The other one, 'plugins-custom', consists of plugins that we wrote ourself. |
|
|
|
|
|
|
|
|
To clone both the varia.website and pelican-plugins repository, add the --recurse-submodules option in your git clone command: |
|
|
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` |
|
|
``` |
|
|
|
|
|
$ git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules |
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
## Install |
|
|
## Install |
|
|
|
|
|
|
|
|
$ pip3 install -r requirements.txt |
|
|
``` |
|
|
|
|
|
$ python3 -m venv .venv |
|
|
|
|
|
$ source .venv/bin/activate |
|
|
|
|
|
$ pip install -r requirements.txt |
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
## Start |
|
|
## Start |
|
|
|
|
|
|
|
|
You can make use of the makefile, for example by running the following command to start a python server: |
|
|
``` |
|
|
|
|
|
$ pelican --autoreload |
|
|
$ make devserver |
|
|
``` |
|
|
|
|
|
|
|
|
Visit the website at localhost:8000 |
|
|
Visit the website at [localhost:8000](http://localhost:8000) |
|
|
|
|
|
|
|
|
## Update submodules |
|
|
## Update submodules |
|
|
|
|
|
|
|
|
We are currently using two submodules: |
|
|
We are currently using two submodules: |
|
|
|
|
|
|
|
|
* pelican-plugins ([https://github.com/getpelican/pelican-plugins](https://github.com/getpelican/pelican-plugins)) |
|
|
- 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)) |
|
|
- plugins-custom ([https://git.vvvvvvaria.org/varia/plugins-custom](https://git.vvvvvvaria.org/varia/plugins-custom)) |
|
|
|
|
|
|
|
|
To update these submodules within your (already) cloned repository, first init the submodule, and then update it: |
|
|
To update these submodules within your (already) cloned repository, first init the submodule, and then update it: |
|
|
|
|
|
|
|
@ -67,9 +72,12 @@ that each article contains at least the following at the top of the document: |
|
|
Tags: event, workshop |
|
|
Tags: event, workshop |
|
|
slug: the-name-of-the-html-page |
|
|
slug: the-name-of-the-html-page |
|
|
lang: nl OR en |
|
|
lang: nl OR en |
|
|
|
|
|
event_start: 2017-07-07 18:32 |
|
|
|
|
|
event_duration:4h |
|
|
|
|
|
featured_image: /images/image.png |
|
|
|
|
|
|
|
|
Articles are written in a markup language called markdown. |
|
|
Articles are written in a markup language called markdown. |
|
|
|
|
|
|
|
|
[Here](https://daringfireball.net/projects/markdown/syntax) is an overview of the syntax. |
|
|
[Here](https://daringfireball.net/projects/markdown/syntax) is an overview of |
|
|
|
|
|
the syntax. You can also use the online editor in this Gitea interface to help |
|
|
You can also use the online editor in gitlab to help you. |
|
|
you. |
|
|