Getting Started

Christian Külker

2020-04-25

To create your first website with Pankyll this guide uses two steps. The first step is to install Pankyll and the second step is to use an example website to kick start your website.

Installing Pankyll

Install the Pankyll dependencies, like YAML, Jinja2, Pandoc and some fonts. Depending on your system the procedure might be different. The following instruction is for Debian 10 Buster.

aptitude install pandoc python3-yaml python3-jinja2 fonts-noto-cjk \
fonts-wqy-microhei

This is the quick guide version on how to “install” and use the command line tool of Pankyll. Under Linux just clone the git repository.

cd
git clone https://github.com/ckuelker/pankyll.git

The script pankyll is inside the bin directory. So the easiest it to change your PATH lets assume you would like to use it from your home directory.

cd
export PATH=$HOME/panlyll/bin:$PATH

Now when you enter pankyll inside the terminal it should find and execute the pankyll command.

Install An Example

To use the example easily the make can be used. In case it is not installed, it can be installed on Debian 10 Buster like this.

aptitude install make

Of course you can now create your new website from scratch. However the explanation would be quite long. For your first website it is recommended to use a theme example. Chose one repository from the theme example page and clone this repository. In the example below replace NAME with the name of the example theme. For example newspaper, rankle or simplicissimus.

cd
git clone https://github.com/ckuelker/pankyll-theme-NAME-example.git

To test if your setup is OK either enter the example directory and execute the pankyll command or execute make build. To see the result with your browser you can use make server.