Browse code

added setup instructions for third party integrations

B Mathis authored on 06/11/2009 at 05:35:53
Showing 2 changed files
... ...
@@ -49,6 +49,26 @@ Kills the local web server process.
49 49
 
50 50
 *There are more but these are the ones you'll use the most. Read the Rakefile if you want to learn more*
51 51
 
52
+## Third Party Integration
53
+### Twitter
54
+To configure your twitter feed, edit twitter.js where you can set:
55
+
56
+- Account for the feed
57
+- Number of tweets to show
58
+- Show Mentions (true/false)
59
+
60
+### Disqus Comments
61
+Octopress has built in support for the Disqus commenting system, using the "universal code" installation method. First register your site at [http://disqus.com/comments/register/](http://disqus.com/comments/register/) Then, to enable Disqus comments on your blog, edit the YAML block at the top of the default layout:
62
+
63
+1. Add your site's Disqus shortname
64
+2. Add your site's full url eg: http://yoursite.com
65
+
66
+### Google Site Search
67
+First setup sitesearch for your site at [http://google.com/sitesearch/](http://google.com/sitesearch/) then add your site\_search\_id to the YAML block in the default layout.
68
+
69
+### Google Analytics
70
+The analytics tracking scripts are already integrated into Octopress, all you have to do is register your site at [http://google.com/analytics/](http://google.com/analytics/).
71
+
52 72
 ## Style Configuration
53 73
 ### What you need to know
54 74
 Octopress's stylesheets are written in [SASS](http://sass-lang.com). If you haven't learned SASS, you should. It's the future. Octopress also uses [Compass](http://compass-style.org) which is a framework for SASS and contains a great library of SASS mixins which make it trivial to write complicated CSS. This is also the future.
... ...
@@ -2,7 +2,7 @@
2 2
 blog_title: My Octopress Blog
3 3
 full_url:
4 4
 google_site_search_id: 
5
-disqus_site: designenthusiast
5
+disqus_short_name: designenthusiast
6 6
 ---
7 7
 
8 8
 !!! 1.1 Transitional
... ...
@@ -53,7 +53,7 @@ disqus_site: designenthusiast
53 53
                 var disqus_url = "#{page.full_url}/#{page.url}";
54 54
               %noscript
55 55
                 %a(href="http://designenthusiast.disqus.com/?url=ref") View the discussion thread
56
-              %script(type="text/javascript" src="http://disqus.com/forums/#{page.disqus_site}/embed.js")
56
+              %script(type="text/javascript" src="http://disqus.com/forums/#{page.disqus_short_name}/embed.js")
57 57
           - else
58 58
             = content
59 59
         #sidebar
... ...
@@ -74,7 +74,7 @@ disqus_site: designenthusiast
74 74
               query += 'url' + i + '=' + encodeURIComponent(links[i].href) + '&';
75 75
             }
76 76
           }
77
-          document.write('<script charset="utf-8" type="text/javascript" src="http://disqus.com/forums/#{page.disqus_site}/get_num_replies.js' + query + '"></' + 'script>');
77
+          document.write('<script charset="utf-8" type="text/javascript" src="http://disqus.com/forums/#{page.disqus_short_name}/get_num_replies.js' + query + '"></' + 'script>');
78 78
         })();
79 79
     //Google Analytics code
80 80
     :javascript