Ghost/docs/ghost/config.html
2013-05-11 17:44:25 +01:00

42 lines
4.2 KiB
HTML

<!DOCTYPE html><html lang="en"><head><title>ghost/config</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="ghost/config"><meta name="groc-project-path" content="ghost/config.js"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">ghost/config.js</div></div><div id="document"><div class="segment"><div class="comments"><div class="wrapper"><h1 id="ghost-configuration">Ghost Configuration</h1></div></div></div><div class="segment"><div class="code"><div class="wrapper"><span class="cm">/**</span>
<span class="cm"> * global module</span>
<span class="cm"> **/</span>
<span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
<span class="cm">/**</span>
<span class="cm"> * @module config</span>
<span class="cm"> * @type {Object}</span>
<span class="cm"> */</span>
<span class="kd">var</span> <span class="nx">config</span> <span class="o">=</span> <span class="p">{};</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><h2 id="admin-settings">Admin settings</h2></div></div></div><div class="segment"><div class="code"><div class="wrapper"> <span class="cm">/**</span>
<span class="cm"> * @property {string} defaultLang</span>
<span class="cm"> */</span>
<span class="nx">config</span><span class="p">.</span><span class="nx">defaultLang</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><h2 id="themes">Themes</h2></div></div></div><div class="segment"><div class="code"><div class="wrapper"> <span class="cm">/**</span>
<span class="cm"> * @property {string} themeDir</span>
<span class="cm"> */</span>
<span class="nx">config</span><span class="p">.</span><span class="nx">themeDir</span> <span class="o">=</span> <span class="s1">&#39;skins&#39;</span><span class="p">;</span>
<span class="cm">/**</span>
<span class="cm"> * @property {string} activeTheme</span>
<span class="cm"> */</span>
<span class="nx">config</span><span class="p">.</span><span class="nx">activeTheme</span> <span class="o">=</span> <span class="s1">&#39;casper&#39;</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><h2 id="homepage-settings">Homepage settings</h2></div></div></div><div class="segment"><div class="code"><div class="wrapper"> <span class="cm">/**</span>
<span class="cm"> * @module homepage</span>
<span class="cm"> * @type {Object}</span>
<span class="cm"> */</span>
<span class="nx">config</span><span class="p">.</span><span class="nx">homepage</span> <span class="o">=</span> <span class="p">{};</span>
<span class="cm">/**</span>
<span class="cm"> * @property {number} features</span>
<span class="cm"> */</span>
<span class="nx">config</span><span class="p">.</span><span class="nx">homepage</span><span class="p">.</span><span class="nx">features</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="cm">/**</span>
<span class="cm"> * @property {number} articles</span>
<span class="cm"> */</span>
<span class="nx">config</span><span class="p">.</span><span class="nx">homepage</span><span class="p">.</span><span class="nx">articles</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span>
<span class="cm">/**</span>
<span class="cm"> * @property {Object} exports</span>
<span class="cm"> */</span>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="nx">config</span><span class="p">;</span>
<span class="p">}());</span></div></div></div></div></body></html>