Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 3.47 KB

salt-description.md

File metadata and controls

57 lines (39 loc) · 3.47 KB

HubPress A web application to build your blog on GitHub

What is HubPress?

HubPress is a blogging tool powered by GitHub Pages and Asciidoctor. The goal of HubPress is similiar to Jekyll, Octopress or Awestruct: to build static content on GitHub Pages. What sets HubPress apart from these tools is that we wanted to provide a tool that is more user-friendly and accessible for everyone.

GitHub Pages requires a non-trivial amount of technical knowledge to configure and get to a working blog site, particulary if you want to use AsciiDoc as the language you write your content in. At a minimum, you need the following pre-requisite knowledge, or be able to learn it quickly:

  • Understand how to use Git.
  • Learn how to install and configure Ruby.
  • Choose from a myriad of static site generators and technologies.
  • Understand the build process of each static site builder, all of which differ slightly.

For the avearage person who just wants to write and share their thoughts, this list alone makes them turn away from a GitHub Pages solution and look to other "just use it" solutions such as WordPress, Medium, and Blogger.

With HubPress all you need is an Internet connection and a GitHub account and you can start blogging within a few minutes. To save or publish a post, one click in the editing interface is all that is required. HubPress takes all the rough edges out of the GitHub Pages blogging experience, and makes it as easy as using something like Blogger or WordPress.

Because we love the AsciiDoc markup format, we wanted a way to introduce folks to the benefits of the markup language, while simultaneously contributing to the adoption of AsciiDoc as a writing format for professional writers and bloggers.

These are the reasons why we made HubPress.

HubPress is:

  1. Easy to use: no technical skills required.
  2. Free: no subscription, and you don’t have to pay rent for a server.
  3. Yours: once HubPress is forked installed in your GitHub repository, you can do as you please with it.

HubPress is inspired by Ghost and uses part of its code to render your blog. To provide a better user experience, we made a web interface based on Asciidoctor with Asciidoctor.js, which is the javascript version.

Why we need your help?

Originally, HubPress started out as a proof of concept with Asciidoctor.js and IndexDB. However, With the overwhelming adoption of the platform (over 1600 unique forks on GitHub), HubPress is becoming harder to support and maintain in a way that will allow it to grow and evolve.

Roadmap

Short Term

  1. Full-time Dedication to the HubPress Project
  2. Add Page Creation
  3. Add RSS Feed
  4. Add Sitemap.xml Generation
  5. Add Delete feature
  6. Add i18n in the Admin Interface
  7. Add AsciiDoc(tor) Cheatsheets
  8. Enhance the Documentation
  9. Enhance the Integration of Developers

Long Term

  1. Add an Images Manager
  2. Add a Themes Manager
  3. Add a Search Feature
  4. Integration in Tools Like an IDE
  5. Build a HubPress Server
  6. Create a Platform for all HubPress Bloggers