Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 4.37 KB

README.adoc

File metadata and controls

103 lines (71 loc) · 4.37 KB
Raw

HubPress

1. What Is HubPress?

editor

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.

If you see something wrong with the documentation, please raise an issue. Your help with improving every aspect of HubPress is greatly appreciated. Pull Requests are always welcome. See the Contributing guide for more information.

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. Use the github.io Domain

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.

  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,

    • repositoryName, which is the new name of the repository fork, <username>.github.io.

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

  4. The following screen indicates you have correctly configured HubPress

    Install complete

3.3. Use a Custom Domain or GitHub Page Domain Already In Use

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.

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

    Settings gh-pages

  2. Switch your repository to the branch gh-pages

    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,

    • repositoryName, which is the repository fork. For example, hubpress.io if you did not rename it.

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

  5. The following screen indicates you have correctly configured HubPress

    Install complete

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.

See the Administration Guide for more information.

4. HubPress Team

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

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

Translations (Japanese) by:

5. Donations

If you love HubPress, and you want to support the team responsible for developing the app, you can use Gratipay 1744073?v=3&s=24. Any donation you give will be put towards development-enabling products like caffeine.