varia.website/README.md

53 lines
1.8 KiB
Markdown
Raw Normal View History

2018-02-01 13:55:35 +01:00
# Varia website
2021-01-19 22:04:56 +01:00
> https://varia.zone
2019-08-26 19:35:56 +02:00
2021-01-19 22:16:57 +01:00
## Hackity Hack Hack
2018-01-27 12:26:51 +01:00
2021-01-19 22:04:56 +01:00
```
$ git clone https://git.vvvvvvaria.org/varia/varia.website.git
$ cd varia.website
2021-01-19 22:16:57 +01:00
$ make
2021-01-19 22:04:56 +01:00
```
2021-01-19 22:04:56 +01:00
Visit the website at [localhost:8000](http://localhost:8000)
2021-01-19 22:16:57 +01:00
## Our Tools
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
2021-01-19 22:22:20 +01:00
features to the generation process of the website. In this repository there is
a folder called 'pelican-plugins' and another one called 'plugins-custom'. The
first one, 'pelican-plugins', is linked to the offical collection of plugins from the
Pelican project
2021-01-19 22:41:50 +01:00
[pelican-plugins](https://github.com/getpelican/pelican-plugins/). The other
2021-01-19 22:22:20 +01:00
one, 'plugins-custom', consists of plugins that we wrote ourself.
## Posting Content
2019-08-25 11:18:41 +02:00
2019-08-26 19:43:58 +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`. This can be done
either locally or via the gitlab interface by creating a new file. Make sure
that each article contains at least the following at the top of the document:
2023-10-24 09:52:22 +02:00
---
Title: een nieuw initiatief
Date: 2017-07-07 18:32
Category: news
Tags: event, workshop
2023-10-24 09:52:22 +02:00
slug: the-name-of-the-html-page-EN OR the-name-of-the-html-page-NL
lang: nl OR en
2021-01-19 22:04:56 +01:00
event_start: 2017-07-07 18:32
event_duration:4h
featured_image: /images/image.png
2023-10-24 09:52:22 +02:00
---
2019-08-26 19:43:58 +02:00
Articles are written in a markup language called markdown.
2021-01-19 22:04:56 +01:00
[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.