User Guide

Joplin Pages Publisher is really easy to use. Just follow these steps:

Guide

Step 0: Github ready

Get a Github account, and create a repository named username.github.io, where username is your username on GitHub.

Then, generate a Github token, and copy it to Joplin Setting Panel of Pages Publisher.

Step 1: Open this plugin's UI

Open Joplin, Menu -> Tools -> Open Pages Publisher, to open this plugin's UI. Now you can see four tabs on top:

1. Site
2. Pages
3. Articles
4. Github

Step 2: Set up Site

In Site panel, you can define some global data and behaviour for you site.

The Theme is the most important configuration item. A theme is a set of pages' templates and configuration. There is a built-in available theme named "Default". Creating you own theme is possible, but in this guide, we'll use the Default theme.

Within the Default theme, Site Name field is required. Fill it and save Site configuration.

Step 3: Set up Pages

In Pages panel, we see four pages in list. This means there will be four types of page in our site, defined by the Default theme.

These four pages are all customizable, which means we can define some data or behaviour for that page. Please customize them one by one, as you like.

Step 4: Add some Articles

In Articles panel, You can search some Joplin notes and add them to Published area. Notes in Published area will be transormed to HTML documents, using the template defined by theme.

Step 5: Set up Github inforamtion

In Github panel, fill in your github information. For common users, User Name and Email will be enough.

Step 6: Generate site and Publish

Click Generate button, all necessary files of your site will be generated. And then click Publish button, they will be pushed into your github repository.

congratulation, Your Github Pages website is ready now!