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

updated the readme with ea. install * starting instructins

Browse Source
This commit is contained in:
mb@mb 2018-08-22 21:52:18 +02:00
parent a4bfa88512
commit 8755235664
1 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -6,6 +6,21 @@ The folder 'plugins' is linked to the Pelican project '[pelican-plugins](https:/
`git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules`
## 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
## Update submodules
We are currently using two submodules:
@ -23,24 +38,26 @@ To update these submodules within your (already) cloned repository, first init t
## Posting Content
We're using a platform called pelican to generate static websites. The main way to add content to the website is by making 'posts' in the folder `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 page by creating a new file.
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
Category: news
slug: the name of the html page
lang: nl or en
Tags: event, workshop
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.
## Layout & theme
todo
Articles are written in a 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.
## Editing templates
todo
## The 'theme'
todo