You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 9, 2023. It is now read-only.
HubPress is a web application that makes it easy for you to maintain a blog. It provides the following features:
17
14
18
15
* WYSIWYG editor for writing blog posts.
19
16
* Backed by the power of http://asciidoctor.org/docs/user-manual/[AsciiDoc markup] for tight control of content presentation to your requirements.
20
17
* Administration console to customise many aspect of your blog's content.
21
18
* Disqus integration for blog comments.
22
-
* Google Analytics integration to track visitor activity.
19
+
* Google Analytics integration to track visitor activity.
23
20
* A number of different themes shipped with the product, ready to use.
24
21
25
22
Hosting for your blog is provided by GitHub Pages.
26
23
27
-
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.
28
-
29
-
See the link:CONTRIBUTING.adoc[Contributors Guide] for more information about being a successful HubPress contributor.
24
+
Your help with improving every aspect of HubPress is greatly appreciated.
25
+
Pull Requests are *always* welcome.
26
+
See https://hubpress.gitbooks.io/hubpress-knowledgebase/content/develop/contribute_pr.html[How do I contribute a PR] on the HubPress Knowledgebase to learn more about contributing.
30
27
31
-
== Browser Compatibility
28
+
== Browser compatibility
32
29
33
30
HubPress is compatible with Chrome Desktop, Firefox Desktop, and Chrome for Android.
34
31
35
-
== Getting Started
32
+
== Getting started
36
33
37
-
=== Fork the Repository
34
+
=== Fork the repository
38
35
39
36
Click the Fork icon image:http://hubpress.io/img/fork-icon.png[Fork,80] to create a copy of this repository within your GitHub account.
40
37
41
-
=== Use the github.io Domain
38
+
=== Configure the correct branch
42
39
43
-
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.
40
+
IMPORTANT: The GitHub branch you select is important, and choosing the incorrect one will cause issues with logging onto HubPress for the first time.
44
41
45
-
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.
42
+
Read the next two sections *carefully* *_before_* choosing which branch and `config.json` file to edit.
43
+
44
+
==== I am not using my GitHub Pages domain for any other project
45
+
46
+
If you are not using your github.io Pages domain you can use it to quickly set up HubPress.
47
+
48
+
With this method, only a few steps are required to get HubPress deployed and ready for use.
49
+
50
+
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.
46
51
47
52
. Rename your repository to `<username>.github.io`
=== Use a Custom Domain or GitHub Page Domain Already In Use
67
+
==== I am using my GitHub Pages domain already, or I want to use a custom domain
68
+
69
+
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.
63
70
64
-
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.
71
+
You need to set your blog up on a sub-domain of your GitHub Pages site.
65
72
66
73
. In the repository settings, set the default branch to `gh-pages`:
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.
93
+
== Getting first-run help
87
94
88
-
See the link:Administration.adoc[Administration Guide] for the next steps you need to take in setting up your HubPress blog.
95
+
If you can't get past the login screen, re-read the instructions above.
96
+
You most likely have configured the wrong branch and will need to fix this before you can begin using HubPress.
89
97
90
-
Once you've completed the configuration aspects, you can write your first blog post. Follow the guidelines in the link:Writers_Guide.adoc[Writer's Guide] to write a sucessful first blog post.
98
+
IMPORTANT: Misconfiguration is the most common issue for folks when trying to log onto HubPress for the first time.
91
99
92
-
== HubPress Team
100
+
If you have double-checked the setup procedure, you can move to the next step: support.
101
+
102
+
First check https://hubpress.gitbooks.io/hubpress-knowledgebase/content/[HubPress Knowledgebase] and use the search function to see if your problem has already been documented as an article.
103
+
104
+
If your issue is not covered by the Knowledgebase, join https://hubpressio.slack.com[HubPress Slack] and report the issue in #general.
105
+
106
+
== How do I start blogging?
107
+
108
+
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.
109
+
110
+
111
+
You can find out how to use HubPress by reading the https://hubpress.gitbooks.io/hubpress-knowledgebase/content/[HubPress Knowledgebase], which is hosted by the team at https://gitbook.com[GitBook.com].
112
+
113
+
== The HubPress team
93
114
94
115
Code by http://github.com/anthonny[Anthonny Quérouil] (Twitter - http://twitter.com/anthonny_q[@anthonny_q]).
95
116
96
-
English Docs by http://github.com/jaredmorgs[Jared Morgan] (Twitter - http://twitter.com/jaredmorgs[@jaredmorgs]).
117
+
English docs by http://github.com/jaredmorgs[Jared Morgan] (Twitter - http://twitter.com/jaredmorgs[@jaredmorgs]).
It's not the only way you can help us, but it is certainly a welcome one.
110
-
Donations are a great way to show your appreciation for the platform: it inspires us to dedicate extra time away from our families and day jobs to make HubPress an awesome blogging platform for you.
126
+
HubPress is powered by :beer:, :coffee: and :pizza:.
0 commit comments