A web application to build your blog on GitHub
CSS JavaScript HTML Other
Clone or download
Latest commit 373d4c9 May 12, 2018

README.adoc

HubPress

1. What Is HubPress?

d7cbf68e 038b 11e7 8465 5c70abd852e1

HubPress is a web application that makes it easy for you to maintain a blog. It provides the following features:

  • WYSIWYG editor for writing blog posts.

  • Backed by the power of AsciiDoc markup for tight control of content presentation to your requirements.

  • Administration console to customise many aspect of your blog’s content.

  • Disqus integration for blog comments.

  • Google Analytics integration to track visitor activity.

  • A number of different themes shipped with the product, ready to use.

Hosting for your blog is provided by GitHub Pages.

Your help with improving every aspect of HubPress is greatly appreciated. Pull Requests are always welcome. See How do I contribute a PR on the HubPress Knowledgebase to learn more about contributing.

2. Browser compatibility

HubPress is compatible with Chrome Desktop, Firefox Desktop, and Chrome for Android.

3. Getting started

3.1. Fork the repository

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

3.2. Configure the correct branch

Important
The GitHub branch you select is important, and choosing the incorrect one will cause issues with logging onto HubPress for the first time.

Read the next two sections carefully before choosing which branch and config.json file to edit.

3.2.1. I am not using my GitHub Pages domain for any other project

If you are not using your github.io Pages domain you can use it 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.
  1. Rename your repository to <username>.github.io

  2. Set values in hubpress/config.json

    Edit config

    The following parameters are mandatory:

    • username, which is your GitHub user name. For example janesmith.

    • repositoryName, which is the new name of the repository fork using the pattern janesmith.github.io.

  3. Commit the changes, and open the GitHub Pages domain: https://janesmith.github.io/.

  4. The following screen indicates you have correctly configured HubPress

    Install complete

3.2.2. I am using my GitHub Pages domain already, or I want to use a custom domain

If you are already using your 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.

You need to set your blog up on a sub-domain of your GitHub Pages site.

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

    Settings gh-pages
  2. Switch your repository to the gh-pages branch.

    Install complete

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

    Edit config

    The following parameters are mandatory:

    • username, which is your GitHub user name. For example janesmith.

    • repositoryName, which is the new name of the repository fork. For example, janesmith.github.io.

  4. Commit the changes, and open the GitHub Pages domain: https://janesmith.github.io/<repositoryName>/.

  5. The following screen indicates you have correctly configured HubPress

    Install complete

4. Getting first-run help

If you can’t get past the login screen, re-read the instructions above. You most likely have configured the wrong branch and will need to fix this before you can begin using HubPress.

Important
Misconfiguration is the most common issue for folks when trying to log onto HubPress for the first time.

If you have double-checked the setup procedure, you can move to the next step: support.

First check HubPress Knowledgebase and use the search function to see if your problem has already been documented as an article.

If your issue is not covered by the Knowledgebase, join HubPress Slack and report the issue in #general.

5. How do I start blogging?

Now you have successfully configured HubPress, you can customise it by adding social network information, experiment with different themes, and make your HubPress blog your own.

You can find out how to use HubPress by reading the HubPress Knowledgebase, which is hosted by the team at GitBook.com.

6. The HubPress team

Code by Anthonny Quérouil (Twitter - @anthonny_q).

English docs by Jared Morgan (Twitter - @jaredmorgs).

Translations (Japanese) by:

7. Supporting the project

HubPress is powered by 🍺, ☕️ and 🍕.

Use the donation options in the HubPress Settings menu to say thanks: we really appreciate it.