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

Clean up text of README

Browse Source
This commit is contained in:
Luke Murphy 2019-08-26 19:43:58 +02:00
parent 28329bc8bd
commit 2c76838c03
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -4,17 +4,22 @@
## Pelican
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.
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.
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'.
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 first one, 'plugins', is linked to the offical collection of plugins from
the Pelican project '[pelican-plugins](https://github.com/getpelican/pelican-plugins/)'.
The other one, 'plugins-custom', 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:
@ -26,7 +31,6 @@ To clone both the varia.website and pelican-plugins repository, add the --recurs
$ 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:
@ -35,7 +39,6 @@ $ make devserver
Visit the website at localhost:8000
## Update submodules
We are currently using two submodules:
@ -51,14 +54,12 @@ To update these submodules within your (already) cloned repository, first init t
git submodule update
## Posting Content
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:
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:
Title: een nieuw initiatief
Date: 2017-07-07 18:32
@ -67,4 +68,8 @@ Make sure that each article contains at least the following at the top of the do
slug: the-name-of-the-html-page
lang: nl OR en
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.
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.