This is a custom Jekyll theme for Public Data Lab websites.
At the moment it supports only one-page websites compose by three sections:
- Cover image
- Introduction text
- Other texts.
(yes, it's veryveryvery simple).
It is base on the Jeckyll software.
To install it on a mac, follow these steps.
If you're not used to GitHub, we strongly suggest to use GitHub Desktop.
Open the GitHub repository page.
Click on Clone or Download green button.
Click on Open in Desktop
GitHub Dekstop should open, follow the process throught the interface keeping the default options.
Follow these instructions to install jekyll on your computer.
To have a preview on your computer, open the terminal, browse to the website folder and then run the command bundle exec jekyll serve.
Done! Now open in any browser the url http://localhost:4000/.
To edit the webiste content, just modify the index.md file.
In there you can use the Markdown language to define the structure of contents.
We suggest to use Typora to edit the markdown.
All the content before the <!--more--> tag will be rendered as introduction.
All the content after the <!--more-->tag will be rendered as paragraph text.
Other that the contents, you can define the metadata (e.g. webpage title, theme colours, etc).
If you want to edit these details, modify the _config.yml file.