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

Remove whitespace because $EDITOR

Browse Source
This commit is contained in:
Luke Murphy 2019-08-25 11:16:47 +02:00
parent e6bde5c464
commit 157a40ca6c
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -4,13 +4,13 @@
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.
The other one, 'plugins-custom', consists of plugins that we wrote ourself.
## Clone
@ -39,11 +39,11 @@ Visit the website at localhost:8000
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))
* 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:
cd /path/to/submodule
cd /path/to/submodule
git submodule init
@ -64,13 +64,12 @@ 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.
## Layout & theme
todo
todo
## Editing templates
todo