HubPress is a free, open source tool to build your future awesome blog!
Created and maintained by Anthonny Quérouil (twitter @anthonny_q).
|
Note
|
HubPress is actually in preview, if you find some bugs come to see us. |
Documentation is rapidly evolving as the project gains momentum. Check back regularly for more tips on how to use HubPress.
Click the Fork icon 
If you have never used your GitHub Pages domain before, you can use this procedure to quickly set up HubPress. With this method, only a few steps are required to get HubPress deployed and ready for use.
|
Important
|
If you are currently using your username.github.io GitHub Pages domain for another project, or if you want to use a custom domain name, skip to the next procedure for instructions.
|
-
Rename your repository to
<username>.github.io -
Set values in
hubpress/config.jsonThe following parameters are mandatory :
-
username, which is your GitHub user name, -
repositoryName, which is the new name of the repository fork,<username>.github.io.
-
-
Commit the changes, and open the GitHub Pages domain:
https://<username>.github.io/. -
The following screen indicates you have correctly configured HubPress
If you want your blog to be available on a custom domain, or you are already using your GitHub Pages domain to host another project, some extra configuration is required.
-
In the repository settings, set the default branch to
gh-pages: -
Switch your repository to the branch gh-pages
-
Set the required values in `hubpress/config.json
The following parameters are mandatory :
-
username, which is your GitHub user name, -
repositoryName, which is the repository fork. For example,hubpress.ioif you did not rename it.
-
-
Commit the changes, and open the GitHub Pages domain:
https://<username>.github.io/<repositoryName>/. -
The following screen indicates you have correctly configured HubPress
The HubPress Administration Console is available at /hubpress
-
https://<username>.github.io/hubpress/for GitHub Hosted blogs, or -
https://<username>.github.io/<repositoryName>/hubpress/for Domain Hosted blogs.
Enter your GitHub credentials to log into HubPress Admin.
Once you authenticate, a personal token is created for future calls from HubPress to the GitHub API.
This is synchronized across all sessions of HubPress, so if you open the Administration Console on your PC and then your Tablet, the token is applicable to all devices.
You can configure basic blog settings (such as CNAME and Pagination) and social media accounts you want to connect to your blog.
This section contains basic information configured in the /hubpress/config.json file.
The Git CNAME field is configurable, and lets you specify a custom domain name for your blog. See https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages/ for instructions about setting up a CNAME for your blog.
The Title and Description fields allow you to give your blog a name, and tell visitors what they can expect from your blog posts.
The Logo and Cover Image fields can be used the following ways:
-
A HTML link to an image hosting service. For example gravatar.
-
A link to an image committed to the /images directory of your blog repository.
|
Note
|
See the /images/README.adoc file for tips about embedding images into your blog posts.
|
The Theme is selectable from the list of themes stored in the /themes directory. Specify it according to it is spelled in it’s containing folder.
The Google Analytics field takes the unique Google Analytics code generated for the site.
When you first start HubPress, the Posts view is empty. As you create blog posts, the page populates with the list of posts on the left, and a live preview of the blog post itself on the right.
|
Note
|
If you have never used AsciiDoc before to write content, the AsciiDoctor Writer’s Guide should be your first stop in your journey. The guide provides both basic and advanced mark-up examples for you to copy and use. |
HubPress Editor displays the AsciiDoc code on the left, and the live preview on the right.
The blog title is always Level 1 in an AsciiDoc post. For example, = Blog Title sets the name of the Blog Post to Blog Title.
If you want a first-level heading you use == First Level Heading, and so on to create other nested headings.
If you want to add a cover image to your Blog Post, you must set the hp-image attribute.
For example :
= Blog Title
:hp-image: https://github.com/<username>/<repositoryName>/images/a-cover-image.jpgBy default, the publication date is the date of the day to which you introduced your Blog Post. You can force the publication date by adding the published_at
For example :
= Blog Title
:published_at: 2015-01-31Thanks to Jared Morgan for initially tidying up the README you see here, and continuing to be the "docs guy" for HubPress.