Skip to content

Instantly share code, notes, and snippets.

@jhyland87
Created December 22, 2016 01:23
Show Gist options
  • Save jhyland87/0e6b59834523134e8a5f408d0fa815bb to your computer and use it in GitHub Desktop.
Save jhyland87/0e6b59834523134e8a5f408d0fa815bb to your computer and use it in GitHub Desktop.
geekwiki.local/documentation/index.json
{
"pretty":true,
"site":{
"title":"Some Blog",
"theme":"neutral"
},
"social_networks":{
"facebook":{
"title":"Facebook",
"icon":"facebook",
"href":"https://www.facebook.com/sharer/sharer.php?u={{href}}",
"svg":"M6.546,15V8.805H4.46V6.39h2.086V4.607c0-2.066,1.263-3.19,3.106-3.19c0.883,0,1.642,0.064,1.863,0.094v2.16 h-1.281c-1,0-1.194,0.476-1.194,1.176v1.54h2.39l-0.31,2.416H9.04V15"
},
"twitter":{
"title":"Twitter",
"icon":"twitter",
"href":"https://twitter.com/home?status={{href}}",
"svg":"M16 3.038c-.59.26-1.22.437-1.885.517.677-.407 1.198-1.05 1.443-1.816-.634.375-1.337.648-2.085.795-.598-.638-1.45-1.036-2.396-1.036-1.812 0-3.282 1.468-3.282 3.28 0 .258.03.51.085.75C5.152 5.39 2.733 4.084 1.114 2.1.83 2.583.67 3.147.67 3.75c0 1.14.58 2.143 1.46 2.732-.538-.017-1.045-.165-1.487-.41v.04c0 1.59 1.13 2.918 2.633 3.22-.276.074-.566.114-.865.114-.21 0-.416-.02-.617-.058.418 1.304 1.63 2.253 3.067 2.28-1.124.88-2.54 1.404-4.077 1.404-.265 0-.526-.015-.783-.045 1.453.93 3.178 1.474 5.032 1.474 6.038 0 9.34-5 9.34-9.338 0-.143-.004-.284-.01-.425.64-.463 1.198-1.04 1.638-1.7z"
},
"googleplus":{
"title":"Google+",
"icon":"googleplus",
"href":"https://plus.google.com/share?url={{href}}",
"svg":"M5.09 7.273v1.745H7.98c-.116.75-.873 2.197-2.887 2.197-1.737 0-3.155-1.44-3.155-3.215S3.353 4.785 5.09 4.785c.99 0 1.652.422 2.03.786l1.382-1.33c-.887-.83-2.037-1.33-3.41-1.33C2.275 2.91 0 5.184 0 8s2.276 5.09 5.09 5.09c2.94 0 4.888-2.065 4.888-4.974 0-.334-.036-.59-.08-.843H5.09zM16 7.273h-1.455V5.818H13.09v1.455h-1.454v1.454h1.455v1.455h1.455V8.727H16"
},
"pinterest":{
"title":"Pintrest",
"icon":"pinterest",
"href":"https://pinterest.com/pin/create/button/?url={{href}}&media={{href}}&description={{summary}}",
"svg":"M8 0C3.582 0 0 3.582 0 8c0 3.39 2.108 6.285 5.084 7.45-.07-.633-.133-1.604.028-2.295.146-.625.938-3.977.938-3.977s-.24-.48-.24-1.188c0-1.11.646-1.943 1.448-1.943.683 0 1.012.513 1.012 1.127 0 .687-.436 1.713-.662 2.664-.19.797.4 1.445 1.185 1.445 1.42 0 2.514-1.498 2.514-3.662 0-1.915-1.376-3.254-3.342-3.254-2.276 0-3.61 1.707-3.61 3.472 0 .687.263 1.424.593 1.825.066.08.075.15.057.23-.06.252-.196.796-.223.907-.035.146-.115.178-.268.107-.998-.465-1.624-1.926-1.624-3.1 0-2.524 1.834-4.84 5.287-4.84 2.774 0 4.932 1.977 4.932 4.62 0 2.757-1.74 4.977-4.153 4.977-.81 0-1.572-.422-1.833-.92l-.5 1.902c-.18.695-.667 1.566-.994 2.097.75.232 1.545.357 2.37.357 4.417 0 8-3.582 8-8s-3.583-8-8-8z"
},
"linkedin":{
"title":"LinkedIn",
"icon":"linkedin",
"href":"https://www.linkedin.com/shareArticle?mini=true&url={{href}}&title={{title}}&summary={{summary}}&source={{href}}",
"svg":"M13.632 13.635h-2.37V9.922c0-.886-.018-2.025-1.234-2.025-1.235 0-1.424.964-1.424 1.96v3.778h-2.37V6H8.51V7.04h.03c.318-.6 1.092-1.233 2.247-1.233 2.4 0 2.845 1.58 2.845 3.637v4.188zM3.558 4.955c-.762 0-1.376-.617-1.376-1.377 0-.758.614-1.375 1.376-1.375.76 0 1.376.617 1.376 1.375 0 .76-.617 1.377-1.376 1.377zm1.188 8.68H2.37V6h2.376v7.635zM14.816 0H1.18C.528 0 0 .516 0 1.153v13.694C0 15.484.528 16 1.18 16h13.635c.652 0 1.185-.516 1.185-1.153V1.153C16 .516 15.467 0 14.815 0z"
},
"stumbleupon":{
"title":"StumbleUpon",
"icon":"stumbleupon",
"href":"http://www.stumbleupon.com/submit?url={{href}}&title={{title}}",
"svg":"M8 0C3.58 0 0 3.582 0 8c0 4.42 3.58 8 8 8s8-3.58 8-8c0-4.418-3.58-8-8-8zm-.412 5.938v3.3c0 1.236-1.128 2.167-2.3 2.167-1.096 0-2.12-.518-2.236-1.756V7.587h1.65v1.65c0 .41.29.477.585.477.293 0 .65-.066.65-.478v-3.3c.034-1.236 1.053-2.01 2.194-2.01 1.162 0 1.932.878 1.932 2.01v.696l-.818.39-.832-.39V5.526s-.11-.12-.28-.12c-.283 0-.544.12-.544.532zm5.36 3.3c0 1.236-1.06 2.074-2.235 2.074-1.174 0-2.3-.838-2.3-2.075v-1.65h1.65v1.65c0 .412.357.478.65.478.294 0 .586-.066.586-.478v-1.65h1.648v1.65z"
}
},
"technical":{
"defaults":{
"share":{
"title":"Default Title",
"summary":"Default Summary",
"href":"#Default-Href",
"networks":[
"facebook",
"twitter",
"googleplus",
"pinterest",
"linkedin",
"stumbleupon"
]
},
"export":{
"formats":[
"pdf",
"docx"
]
}
},
"verbosity":{
"all":true,
"include":true
}
},
"title":"Documentation Index",
"layout":"articles/article-page.pug",
"summary":"Documentation Index",
"author":false,
"tags":false,
"share":false,
"contents":"<h1 id=\"documentation\">Documentation</h1>\n<h2 id=\"article-source-format\">Article Source Format</h2>\n<h3 id=\"metadata\">Metadata</h3>\n<p>The article <em>MetaData</em> is placed in the very top of the <code>.md</code> file, with three hyphens above and below it.</p>\n<table>\n<thead>\n<tr>\n<th>Key</th>\n<th style=\"text-align:center\">Req</th>\n<th style=\"text-align:center\">Type</th>\n<th>Desc</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>title</code></td>\n<td style=\"text-align:center\"><strong>Y</strong></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>The articles title</td>\n<td>Parsed version of URL</td>\n</tr>\n<tr>\n<td><code>summary</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>The articles summary</td>\n<td><code>undefined</code></td>\n</tr>\n<tr>\n<td><code>layout</code></td>\n<td style=\"text-align:center\"><strong>Y</strong></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>The layout/template to use</td>\n<td><em>None</em></td>\n</tr>\n<tr>\n<td><code>author</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em>,<em>object</em></td>\n<td>Author data</td>\n<td>Github Username of initial committer</td>\n</tr>\n<tr>\n<td><code>author.username</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>Authors Github username</td>\n<td>Github Username of initial committer</td>\n</tr>\n<tr>\n<td><code>author.firstname</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>Authors <em>first</em> name</td>\n<td><code>undefined</code></td>\n</tr>\n<tr>\n<td><code>author.lastname</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>Authors <em>last</em> name</td>\n<td><code>undefined</code></td>\n</tr>\n<tr>\n<td><code>author.href</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em>,<em>object</em></td>\n<td>Address to hyperlink to (<code>string</code>), or <code>false</code> to remove hyperlink</td>\n<td>Github URL of authors account</td>\n</tr>\n<tr>\n<td><code>author.prefix</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em>,<em>object</em></td>\n<td>Prefix of the Author thingy</td>\n<td>&quot;By&quot;</td>\n</tr>\n<tr>\n<td><code>share</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>object</em>,<em>boolean</em></td>\n<td>Sharing Settings</td>\n<td></td>\n</tr>\n<tr>\n<td><code>share.title</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>The articles title (to override the articles <code>title</code> value)</td>\n<td>Articles primary <code>title</code></td>\n</tr>\n<tr>\n<td><code>share.summary</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>The articles summary (to override the articles <code>summary</code> value)</td>\n<td>Articles primary <code>summary</code></td>\n</tr>\n<tr>\n<td><code>share.href</code></td>\n<td style=\"text-align:center\"><em>N</em></td>\n<td style=\"text-align:center\"><em>string</em></td>\n<td>The articles href (to override the articles <code>href</code> value)</td>\n<td>Articles primary <code>href</code></td>\n</tr>\n</tbody>\n</table>\n<p>An example of the metadata section from an existing .md file:</p>\n<pre><code>---\ntitle: &quot;Article Title&quot;\nlayout: &quot;articles/article-page.pug&quot;\nsummary: &quot;This is the summary of the article&quot;\nauthor:\n firstname: &quot;Justin&quot;\n lastname: &quot;Hyland&quot;\n username: &quot;jhyland87&quot;\n prefix: &quot;By&quot;\n href: &quot;http://www.jhyland.pro&quot;\ntags: \n - &quot;Tag 1&quot;\n - &quot;Tag 2&quot;\n - &quot;Tag 3&quot;\nshare:\n title: &quot;Checkout This Article!&quot;\n summary: &quot;Short summary for shared link&quot;\n href: &quot;http://geekwiki.local/posts/foo.html&quot;\nexport: [ &quot;pdf&quot;, &quot;docx&quot; ]\n---\n</code></pre><p>blah blah</p>\n<h3 id=\"full-source\">Full Source</h3>\n<pre><code>---\ntitle: &quot;Article Title&quot;\nlayout: &quot;articles/article-page.pug&quot;\nsummary: &quot;This is the summary of the article&quot;\nauthor:\n firstname: &quot;Justin&quot;\n lastname: &quot;Hyland&quot;\n username: &quot;jhyland87&quot;\n prefix: &quot;By&quot;\n href: &quot;http://www.jhyland.pro&quot;\ntags: \n - &quot;Tag 1&quot;\n - &quot;Tag 2&quot;\n - &quot;Tag 3&quot;\nshare:\n title: &quot;Checkout This Article!&quot;\n summary: &quot;Short summary for shared link&quot;\n href: &quot;http://geekwiki.local/posts/foo.html&quot;\nexport: [ &quot;pdf&quot;, &quot;docx&quot; ]\n---\n\n# Hello World! First Heading\n</code></pre>",
"mode":"0644",
"stats":{
"dev":16777220,
"mode":33188,
"nlink":1,
"uid":504,
"gid":20,
"rdev":0,
"blksize":4096,
"ino":29044066,
"size":2714,
"blocks":8,
"atime":"2016-12-21T23:20:56.000Z",
"mtime":"2016-12-21T23:10:28.000Z",
"ctime":"2016-12-21T23:10:28.000Z",
"birthtime":"2016-12-21T21:28:54.000Z"
},
"filename":"/Users/jhyland/Documents/Projects/geekwiki.io/templates/articles/article-page.pug"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment