joak/varia.website
1
0
Fork 0
forked from varia/varia.website
Code Issues Pull Requests Projects Releases Wiki Activity

Take a pass on docs

Browse Source
This commit is contained in:
Luke Murphy 2021-01-19 22:04:56 +01:00
parent 0a491dba08
commit ab94cb5b21
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,6 +1,6 @@
# Varia website
> https://varia.zone/
> https://varia.zone
## 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
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.
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:
`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
$ pip3 install -r requirements.txt
```
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
```
## 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
We are currently using two submodules:
* 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))
- 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))
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
slug: the-name-of-the-html-page
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.
[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.
[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.