Publishing GitHub Pages from Helpinator

GitHub has a nice feature called “GitHub Pages” that allows you to create a nice looking static website from markdown files in your repository.

Helpinator allows to generate required markdown files so you can publish your project end user documentation using GitHub pages in a matter of seconds.

In this tutorial we will create and publish GitHub pages from Helpinator.

First, go to your GitHub account and create a repository for dicumentation. You can skip this step if you wish to add documentation to an existing repository.

Create a repository for documentation

Now you need to clone the repo to your local PC.

Run command prompt, change the folder to our documentation folder, say “C:\Project\Help” and call git:

git clone https://github.com/DmitriPopov/helpinator-github-pages.git

This will create a folder “helpinator-github-pages” in “C:\Project\Help” folder. Browse to it and create “docs” subfolder, this is where we will publish our documentation.

Now launch Helpinator and click lightning bolt icon on the main tool bar.

“Batch compile” dialog appears.

Batch compile

Browse the list of the left to “Github Flavored Markdown” and double-click it to add a new batch item.

Set “Save to” path to the docs folder in our cloned repo folder. Click “Settings”.

GitHub settings

Select “Prepare GitHub Pages source files”, click “OK”.

Now click the lightning bolt icon and Helpinator will generate all required project files.

Now we can commit documentation files generated by Helpinator to our repository.

Open command prompt again, browse to the “docs” folder inside the cloned repository folder and run the following commands:

git add --all
git commit -m "First version"
git push

Now we can open our repo on GitHub and proceed to repo settings:

Click “Settings”

Scroll down to “GitHub Pages” section.

GitHub pages section

Select “master branch / docs folder’ as the source. And then pick a theme of your choice that will be applied to your pages.

When everything is ready, the top of “GitHub Pages” section will show a link to your GitHub Pages website:

The link to the result

The result of this tutorial is available here: https://dmitripopov.github.io/helpinator-github-pages/

Leave a comment

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.