Support center for the minimalist. Generates a beautiful, responsive knowledge base with advanced search and analytics. It is search friendly and you can deep link into articles.
The support center uses Swiftype.com for searching, which allows you to index a subdomain such as support.shopstarter.com and it shows you what people are searching for, but do not find! For analytics, it uses Google Analytics and generates events when visitors report article as helpful, not helpful, or incorrect. The last dependency is on Normalize CSS hosted by Yahoo's CDN. With only these few dependencies you don't need to create any SQL tables.
View live demo here: http://support.shopstarter.com
- Powerful search using Swiftype (discover what people are not finding!)
- Reports articles helpful, not helpful or incorrect using Google Analytics events
- Google Analytics for detailed usage reports
- Minimalist: only 3 dependencies, written in PHP without need for database
- Responsive layout works on mobile and desktop
If you already have a GIT repo for your server, then:
git submodule add https://github.com/kennberg/php-support-center support
git submodule init
Or, for installation inside your server directory:
git clone https://github.com/kennberg/php-support-center support
To add a new article make sure the category exists first by creating a directory, then create a corresponding PHP file. For consistency, separate words with dashes (-) in the directories and filenames. For example:
cd php-support-center
mkdir -p articles/example
vim articles/example/first-article.php
You should also add the new category and article to the visibility whitelist:
vim articles/visible.php
Template for the article is located in the "templates" folder, which contains configuration for your Swiftype and Google Analytics IDs.
All the media such as CSS and images for the articles are located in the "media" folder. They can be referenced in the article with the "media/" prefix:
<img src="media/do-it-yourself.png" />
You should modify your ".htaccess" in "www" folder for Apache to rewrite all the traffic to support.yourdomain.com to go directly to the index.php file. You could also just host it from the /support/ path. Either way here are some rewrite rules for you reference:
# Mapping for subdomain suh as support.yourdomain.com
RewriteCond ${lowercase:%{SERVER_NAME}} ^support\.yourdomain\.com
RewriteRule media/(.*)$ media/$1 [L]
RewriteCond ${lowercase:%{SERVER_NAME}} ^support\.yourdomain\.com
RewriteRule ^.*$ index.php [L]
# Mapping for direct use without custom subdomain
RewriteRule media/(.*)$ media/$1 [L]
RewriteRule ^.*$ index.php [L]
Apache v2. See the LICENSE file.