HubPress

What Is HubPress?

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.

Complete documentation is coming here soon!

Getting Started

Installation

Fork the repository

Click the Fork icon to create a copy of this repository within your GitHub account.

Use the github.io domain

Only a few steps are required to get HubPress deployed and ready for use.

Note	Custom Domain If you have a custom domain name, skip to the next procedure for instructions.

1. Set values in hubpress/config.json

   

   The following parameters are mandatory :

   • username: it’s your github username,

   • repositoryName: it’s the name of your fork, hubpress.io if you did not rename it.

2. Commit and open your website http://<username>.github.io/<repositoryName>/.

3. The following screen indicates you have correctly configured HubPress

   

Use a Custom Domain

If you want your blog to be available on a custom domain, some extra configuration is required.

1. In the repository settings, set the default branch to gh-pages :

   

2. Switch your repository to the branch gh-pages

   

3. Set the required values in `hubpress/config.json

   :

   You have two values to set :

   • username: it’s your github username,

   • repositoryName: it’s the name of your fork, hubpress.io if you did not rename it.

4. Commit and open your website http://<username>.github.io/<repositoryName>;.

5. The following screen indicates you have correctly configured HubPress

Usage

The HubPress Administration Console is available at /hubpress

• http://<username>.github.io/hubpress/ for GitHub Hosted blogs, or

• http://<username>.github.io/<repositoryName>/hubpress/ for Domain Hosted blogs.

Connecting HubPress to GitHub

GitHub credentials are required to log into HubPress. Once you authenticate, a personal token is created for future calls from HubPress to the GitHub API.

Settings Page

You can configure basic blog settings (such as CNAME and Pagination) and social media accounts you want to connect to your blog.

Tip	Coming soon

List of posts

Tip	Coming soon.

Your first post

Tip	Coming soon.

==Credits

Tip	Coming soon.