fixes #202 - urls contain reserved chars

- added all reserved chars and \ to the list of chars which get filtered out
- added documentation

core/shared/models/post.js

@@ -58,8 +58,11 @@ Post = GhostBookshelf.Model.extend({
         }
     },
 
+    // #### generateSlug
+    // Create a string act as the permalink for a post.
+    // Remove reserved chars: `:/?#[]@!$&'()*+,;=` as well as `\` and convert spaces to hyphens
     generateSlug: function () {
-        return this.set('slug', this.get('title').replace(/\:/g, '').replace(/\s/g, '-').toLowerCase());
+        return this.set('slug', this.get('title').replace(/[:\/\?#\[\]@!$&'()*+,;=\\]/g, '').replace(/\s/g, '-').toLowerCase());
     },
 
     user: function () {
@@ -72,21 +75,24 @@ Post = GhostBookshelf.Model.extend({
 
 }, {
 
-    /**
+     // #### findPage
-     * Find results by page - returns an object containing the
+     // Find results by page - returns an object containing the
-     * information about the request (page, limit), along with the
+     // information about the request (page, limit), along with the
-     * info needed for pagination (pages, total).
+     // info needed for pagination (pages, total).
-     *
+
-     * {
+     // **response:**
-         *   posts: [
+
-         *    {...}, {...}, {...}
+     //     {
-         *   ],
+     //         posts: [
-         *   page: __,
+     //         {...}, {...}, {...}
-         *   limit: __,
+     //     ],
-         *   pages: __,
+     //     page: __,
-         *   total: __
+     //     limit: __,
-         * }
+     //     pages: __,
-     *
+     //     total: __
+     //     }
+
+    /*
      * @params opts
      */
     findPage: function (opts) {