How I built my Github Homepage

using the ReAdABLE Human Format

Goal of this article

The purpose of this article is to show how to easily build a Github page with the ReAdABLE Human Format.

Pre-requisites

You should have a Github activated account
You should have VSCode and Red extension installed so that you can run red script easily
Or use any other text editor and run a batch file provided.

Tips: for spell checking I also use Spell Checker extension

Tips: for quick image upload, I’m using https://imgur.com/upload which supports pasting image directly in the browser.

Know the homepage url

The homepage url of my homepage is http://lepinekong.github.io/.

The first time you visit it, you’ll get a 404 error page:

Create a Repository

You must first create a repository by clicking on the “+” icon near your user icon on the top right.

Check your homepage

You can check that your homepage in my case at http://lepinekong.github.io/ doesn’t show 404 error any more.

Settings

Click on settings

Choose a theme

You can set a theme for your site by clicking on button “Choose a theme”

Pick one of them

by choosing one theme among those available:

Revisit homepage

You can check your homepage once more in my case at http://lepinekong.github.io/ you should see your new homepage updated:

Setting up a ReAdABLE Human Format Folder

Next let’s write the content in ReAdABLE Human Format.

Go to https://gist.github.com/lepinekong/b59fa3e8d386dea1ebaa1a096488c542

Click on .ReAdABLE.HumanFormat.deploy.ps1 “Raw” button on the right side

Copy the whole content to clipboard

Select with Ctrl+A then copy with Ctrl+C.

Paste the whole content in Powershell console

Run Powershell Console (in windows search type “Powershell”)
Then right-click with the mouse on it to paste the content
Validate to execute

Choose a target folder

By default it is C:\red\demos\ReAdABLE.Human.Format but you can type any folder for example C:\rebol.system.user.code.domains.apps\Authoring\app\github.pages\github.pages.doc
Validate.

Confirm source download

You should see:

A Red console running the markdown generator on the sample article
A popup window asking to confirm source download: you must confirm this latter if you want to modify the article in ReAdABLE format.

Optionally rename the folder and open it with Visual Studio Code

You can rename the folder to doc if preferred, it is shorter and gets a nice icon under Visual Studio Code.

Write your article

You can write your own article by modifying the content of the template (if needed by deleting or adding new paragraphs).

Beware: Paragraphs labels can be almost any Red variable name (no space allowed) but they should be different (for example P1, P2,… or Goal-of-this-article, Pre-requisites,…) so P, P,… will not work well when converting to Markdown.