KatanaCode/blogit

View on GitHub
doc/Blogit/Configuration.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Class: Blogit::Configuration
  
    &mdash; Blogit - Add a blog to your Ruby on Rails application
  
</title>

  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '../';
  framesUrl = "../frames.html#!Blogit/Configuration.html";
</script>


  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="../_index.html">Index (C)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../Blogit.html" title="Blogit (module)">Blogit</a></span></span>
     &raquo; 
    <span class="title">Configuration</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="../method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="../file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><h1>Class: Blogit::Configuration
  
  
  
</h1>

<dl class="box">
  
    <dt class="r1">Inherits:</dt>
    <dd class="r1">
      <span class="inheritName">Object</span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next">Blogit::Configuration</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
      </dd>
    
  
  
    
  
    
      <dt class="r2">Includes:</dt>
      <dd class="r2">ActiveSupport::Configurable</dd>
      
    
  
  
  
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">lib/blogit/configuration.rb</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    <p>This class handles the global configuration options for Blogit.
When you run <code>rails g blogit:install</code> this will add an initializer file to
config/initializers/blogit.rb with all of the default configurations applied.</p>

<p>You can read about each of the individual configuration options below.</p>


  </div>
</div>
<div class="tags">
  

</div>
  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="ACTIVE_STATES-constant" class="">ACTIVE_STATES =
          <div class="docstring">
  <div class="discussion">
    <p>An Array containing the default states for <span class='object_link'><a href="Post.html" title="Blogit::Post (class)">Posts</a></span> that are considered 
&quot;active&quot;. (&quot;Active&quot; <span class='object_link'><a href="Post.html" title="Blogit::Post (class)">posts</a></span> are those that can be viewed by the public).</p>


  </div>
</div>
<div class="tags">
  

</div>
        </dt>
        <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:published</span><span class='rbracket'>]</span></pre></dd>
      
        <dt id="HIDDEN_STATES-constant" class="">HIDDEN_STATES =
          <div class="docstring">
  <div class="discussion">
    <p>An Array containing the default states for <span class='object_link'><a href="Post.html" title="Blogit::Post (class)">Posts</a></span> that are considered 
&quot;hidden&quot;. (&quot;Hidden&quot; <span class='object_link'><a href="Post.html" title="Blogit::Post (class)">posts</a></span> are those that may not be viewed by the public).</p>


  </div>
</div>
<div class="tags">
  

</div>
        </dt>
        <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:draft</span><span class='comma'>,</span> <span class='symbol'>:archive</span><span class='rbracket'>]</span></pre></dd>
      
        <dt id="REDCARPET_OPTIONS-constant" class="">REDCARPET_OPTIONS =
          <div class="docstring">
  <div class="discussion">
    <p>When using redcarpet as content parser, pass these options as defaults.</p>


  </div>
</div>
<div class="tags">
  

</div>
        </dt>
        <dd><pre class="code"><span class='lbrace'>{</span>
  <span class='label'>hard_wrap:</span> <span class='kw'>true</span><span class='comma'>,</span>
  <span class='label'>filter_html:</span> <span class='kw'>true</span><span class='comma'>,</span>
  <span class='label'>autolink:</span> <span class='kw'>true</span><span class='comma'>,</span>
  <span class='label'>no_intra_emphasis:</span> <span class='kw'>true</span><span class='comma'>,</span>
  <span class='label'>fenced_code_blocks:</span> <span class='kw'>true</span><span class='comma'>,</span>
  <span class='label'>gh_blockcode:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='rbrace'>}</span></pre></dd>
      
    </dl>
  







  
    <h2>
      Instance Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#active_states-instance_method" title="#active_states (instance method)">- (Object) <strong>active_states</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>List of states that will be visible to the public.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#ajax_comments-instance_method" title="#ajax_comments (instance method)">- (Object) <strong>ajax_comments</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>If set to true, the comments form will POST and DELETE to the comments controller using AJAX calls.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#blogger_display_name_method-instance_method" title="#blogger_display_name_method (instance method)">- (Object) <strong>blogger_display_name_method</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>What method do we call on blogger to return their display name? (default: :username).</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#current_blogger_method-instance_method" title="#current_blogger_method (instance method)">- (Object) <strong>current_blogger_method</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>The name of the controller method we&#39;ll call to return the current blogger.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#datetime_format-instance_method" title="#datetime_format (instance method)">- (Object) <strong>datetime_format</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Which DateTime::FORMATS format do we use to display blog and comment publish time (default: :short).</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#default_parser-instance_method" title="#default_parser (instance method)">- (Object) <strong>default_parser</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>The default format for parsing the blog content.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#default_parser_class-instance_method" title="#default_parser_class (instance method)">- (Object) <strong>default_parser_class</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#disqus_shortname-instance_method" title="#disqus_shortname (instance method)">- (Object) <strong>disqus_shortname</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>When using :disqus comments, what is the shortname of your forum? (default: nil).</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#disqus_shortname%3D-instance_method" title="#disqus_shortname= (instance method)">- (Object) <strong>disqus_shortname=</strong>(shortname) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Sets <span class='object_link'><a href="#disqus_shortname-instance_method" title="Blogit::Configuration#disqus_shortname (method)">#disqus_shortname</a></span>.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#hidden_states-instance_method" title="#hidden_states (instance method)">- (Object) <strong>hidden_states</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>List of states that will hide the posts from the public.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#highlight_code_syntax-instance_method" title="#highlight_code_syntax (instance method)">- (Object) <strong>highlight_code_syntax</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Should text within &quot;``<code>&quot; or &quot;</code>&quot; be highlighted as code? Defaults to true @note - At the moment this only works when default_parser is :markdown.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#include_comments-instance_method" title="#include_comments (instance method)">- (Object) <strong>include_comments</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>How do you want to handle comments for your blog? Valid options are :active_record, :disquss, or :no for none.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#include_share_bar-instance_method" title="#include_share_bar (instance method)">- (Object) <strong>include_share_bar</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Load a javascript-based share bar on each blog post?.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#layout-instance_method" title="#layout (instance method)">- (Object) <strong>layout</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>The layout to be used by the posts controller.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#posts_per_page-instance_method" title="#posts_per_page (instance method)">- (Object) <strong>posts_per_page</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Number of <span class='object_link'><a href="Post.html" title="Blogit::Post (class)">posts</a></span> to show per page.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#redcarpet_options-instance_method" title="#redcarpet_options (instance method)">- (Object) <strong>redcarpet_options</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>When using redcarpet as content parser, pass these options as defaults.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#rss_feed_description-instance_method" title="#rss_feed_description (instance method)">- (Object) <strong>rss_feed_description</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>The description to use in the index.rss template.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#rss_feed_title-instance_method" title="#rss_feed_title (instance method)">- (Object) <strong>rss_feed_title</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>The title to use in the index.rss template.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#show_post_description-instance_method" title="#show_post_description (instance method)">- (Object) <strong>show_post_description</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Should show a description of the blog post on the index and RSS feed.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#twitter_username-instance_method" title="#twitter_username (instance method)">- (Object) <strong>twitter_username</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Twitter username used in the share bar.</p>
</div></span>
  
</li>

      
    </ul>
  


  

  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="active_states-instance_method">
  
    - (<tt>Object</tt>) <strong>active_states</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>List of states that will be visible to the public</p>

<p>Defaults to ACTIVE_STATES</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


98</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 98</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:active_states</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>ACTIVE_STATES</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="ajax_comments-instance_method">
  
    - (<tt>Object</tt>) <strong>ajax_comments</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>If set to true, the comments form will POST and DELETE to the comments
controller using AJAX calls.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'></span>
      
      
      
        
        <div class='inline'><p>true or false</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


74</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 74</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:ajax_comments</span><span class='rparen'>)</span>  <span class='lbrace'>{</span> <span class='kw'>true</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="blogger_display_name_method-instance_method">
  
    - (<tt>Object</tt>) <strong>blogger_display_name_method</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>What method do we call on blogger to return their display name? (default: :username)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


56</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 56</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:blogger_display_name_method</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='symbol'>:username</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="current_blogger_method-instance_method">
  
    - (<tt>Object</tt>) <strong>current_blogger_method</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>The name of the controller method we&#39;ll call to return the current blogger.
(default: :current_user)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


52</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 52</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:current_blogger_method</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='symbol'>:current_user</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="datetime_format-instance_method">
  
    - (<tt>Object</tt>) <strong>datetime_format</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Which DateTime::FORMATS format do we use to display blog and comment publish time
(default: :short)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


61</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 61</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:datetime_format</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='symbol'>:short</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="default_parser-instance_method">
  
    - (<tt>Object</tt>) <strong>default_parser</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>The default format for parsing the blog content.</p>

<p>Defaults to :markdown</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


80</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 80</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:default_parser</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='symbol'>:markdown</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="default_parser_class-instance_method">
  
    - (<tt>Object</tt>) <strong>default_parser_class</strong> 
  

  

  
</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


131
132
133</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 131</span>

<span class='kw'>def</span> <span class='id identifier rubyid_default_parser_class'>default_parser_class</span>
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Blogit::Parsers::</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_default_parser'>default_parser</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_classify'>classify</span><span class='embexpr_end'>}</span><span class='tstring_content'>Parser</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_constantize'>constantize</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="disqus_shortname-instance_method">
  
    - (<tt>Object</tt>) <strong>disqus_shortname</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>When using :disqus comments, what is the shortname of your forum?
(default: nil)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


39</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 39</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:disqus_shortname</span><span class='comma'>,</span> <span class='label'>instance_writer:</span> <span class='kw'>false</span><span class='rparen'>)</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="disqus_shortname=-instance_method">
  
    - (<tt>Object</tt>) <strong>disqus_shortname=</strong>(shortname) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Sets <span class='object_link'><a href="#disqus_shortname-instance_method" title="Blogit::Configuration#disqus_shortname (method)">#disqus_shortname</a></span>. 
  If the user has defined a disqus shortname but hasn&#39;t set include_comments to
  :disqus will print a warning to the console.</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>shortname</span>
      
      
        <span class='type'></span>
      
      
      
        &mdash;
        <div class='inline'><p>A String with the diquss username to use.</p>
</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


141
142
143
144
145
146
147
148</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 141</span>

<span class='kw'>def</span> <span class='id identifier rubyid_disqus_shortname='>disqus_shortname=</span><span class='lparen'>(</span><span class='id identifier rubyid_shortname'>shortname</span><span class='rparen'>)</span>
  <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_shortname'>shortname</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
  <span class='kw'>unless</span> <span class='id identifier rubyid_include_comments'>include_comments</span> <span class='op'>==</span> <span class='symbol'>:disqus</span>
    <span class='id identifier rubyid_blogit_warn'>blogit_warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>You&#39;ve set config.disqus_shortname in your blogit config file but </span><span class='tstring_end'>&quot;</span></span> \
     <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>config.include_comments is not set to :disqus</span><span class='tstring_end'>&quot;</span></span>
  <span class='kw'>end</span>
  <span class='ivar'>@disqus_shortname</span> <span class='op'>=</span> <span class='id identifier rubyid_shortname'>shortname</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="hidden_states-instance_method">
  
    - (<tt>Object</tt>) <strong>hidden_states</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>List of states that will hide the posts from the public.</p>

<p>Defaults to HIDDEN_STATES</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


104</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 104</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:hidden_states</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>HIDDEN_STATES</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="highlight_code_syntax-instance_method">
  
    - (<tt>Object</tt>) <strong>highlight_code_syntax</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Should text within &quot;``<code>&quot; or &quot;</code>&quot; be highlighted as code?
Defaults to true
@note - At the moment this only works when default_parser is :markdown</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


86</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 86</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:highlight_code_syntax</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='kw'>true</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="include_comments-instance_method">
  
    - (<tt>Object</tt>) <strong>include_comments</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>How do you want to handle comments for your blog?
Valid options are :active_record, :disquss, or :no for none. 
(default: :active_record)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


34</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 34</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:include_comments</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='symbol'>:active_record</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="include_share_bar-instance_method">
  
    - (<tt>Object</tt>) <strong>include_share_bar</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Load a javascript-based share bar on each blog post?. (default: true)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


43</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 43</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:include_share_bar</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='kw'>true</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="layout-instance_method">
  
    - (<tt>Object</tt>) <strong>layout</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>The layout to be used by the posts controller</p>

<p>Defaults to nil</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


121</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 121</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span> <span class='symbol'>:layout</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="posts_per_page-instance_method">
  
    - (<tt>Object</tt>) <strong>posts_per_page</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Number of <span class='object_link'><a href="Post.html" title="Blogit::Post (class)">posts</a></span> to show per page. This is a configuration for <a href="https://github.com/amatsuda/kaminari" target="_parent" title="Kaminari">Kaminari</a> (default: 5)</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'></span>
      
      
      
        
        <div class='inline'><p>an Integer</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


67</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 67</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:posts_per_page</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='int'>5</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="redcarpet_options-instance_method">
  
    - (<tt>Object</tt>) <strong>redcarpet_options</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>When using redcarpet as content parser, pass these options as defaults</p>

<p>Defaults to <span class='object_link'><a href="#REDCARPET_OPTIONS-constant" title="Blogit::Configuration::REDCARPET_OPTIONS (constant)">REDCARPET_OPTIONS</a></span></p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


92</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 92</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:redcarpet_options</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>REDCARPET_OPTIONS</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="rss_feed_description-instance_method">
  
    - (<tt>Object</tt>) <strong>rss_feed_description</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>The description to use in the index.rss template. 
  (default: &quot;Latest from [My Application]&quot;)</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'></span>
      
      
      
        
        <div class='inline'><p>a String</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


115</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 115</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:rss_feed_description</span><span class='comma'>,</span> <span class='label'>instance_reader:</span> <span class='kw'>false</span><span class='rparen'>)</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="rss_feed_title-instance_method">
  
    - (<tt>Object</tt>) <strong>rss_feed_title</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>The title to use in the index.rss template. (default: [My Application] Blog
  Posts&quot;)</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'></span>
      
      
      
        
        <div class='inline'><p>a String</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


110</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 110</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:rss_feed_title</span><span class='comma'>,</span> <span class='label'>instance_reader:</span> <span class='kw'>false</span><span class='rparen'>)</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="show_post_description-instance_method">
  
    - (<tt>Object</tt>) <strong>show_post_description</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Should show a description of the blog post on the index
and RSS feed.</p>

<p>Defaults to true</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


128</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 128</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:show_post_description</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='kw'>true</span> <span class='rbrace'>}</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="twitter_username-instance_method">
  
    - (<tt>Object</tt>) <strong>twitter_username</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Twitter username used in the share bar. (default: nil)</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


47</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit/configuration.rb', line 47</span>

<span class='id identifier rubyid_config_accessor'>config_accessor</span><span class='lparen'>(</span><span class='symbol'>:twitter_username</span><span class='rparen'>)</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

    <div id="footer">
  Generated on Sat Oct 24 19:04:45 2015 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.6 (ruby-2.2.0).
</div>

  </body>
</html>