HPCE/gitea-pages
HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

Added instructions for creating navtabs. Added documentation for configuration file options. Made a few style tweaks. Moved mini-TOC to float on the right. Redid the styling for the mini-TOC bar.

Browse Source
This commit is contained in:
Tom Johnson 2015-05-12 21:21:29 -07:00
parent aaeeeebd85
commit d7b96aa0d2
24 changed files with 412 additions and 1429 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.idea/.name generated
View File

@ -1 +0,0 @@
resolve

7
.idea/dictionaries/tjohnson.xml generated
View File

@ -1,7 +0,0 @@
<component name="ProjectDictionaryState">
<dictionary name="tjohnson">
<words>
<w>linkrefs</w>
</words>
</dictionary>
</component>

22
.idea/inspectionProfiles/Project_Default.xml generated
View File

@ -1,22 +0,0 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="BashAddShebang" enabled="false" level="WARNING" enabled_by_default="false" />
<inspection_tool class="HtmlUnknownTag" enabled="true" level="WARNING" enabled_by_default="true">
<option name="myValues">
<value>
<list size="7">
<item index="0" class="java.lang.String" itemvalue="nobr" />
<item index="1" class="java.lang.String" itemvalue="noembed" />
<item index="2" class="java.lang.String" itemvalue="comment" />
<item index="3" class="java.lang.String" itemvalue="noscript" />
<item index="4" class="java.lang.String" itemvalue="embed" />
<item index="5" class="java.lang.String" itemvalue="script" />
<item index="6" class="java.lang.String" itemvalue="contents" />
</list>
</value>
</option>
<option name="myCustomValuesEnabled" value="true" />
</inspection_tool>
</profile>
</component>

7
.idea/inspectionProfiles/profiles_settings.xml generated
View File

@ -1,7 +0,0 @@
<component name="InspectionProjectProfileManager">
<settings>
<option name="PROJECT_PROFILE" value="Project Default" />
<option name="USE_PROJECT_PROFILE" value="true" />
<version value="1.0" />
</settings>
</component>

14
.idea/misc.xml generated
View File

@ -1,14 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectLevelVcsManager" settingsEditedManually="false">
<OptionsSetting value="true" id="Add" />
<OptionsSetting value="true" id="Remove" />
<OptionsSetting value="true" id="Checkout" />
<OptionsSetting value="true" id="Update" />
<OptionsSetting value="true" id="Status" />
<OptionsSetting value="true" id="Edit" />
<ConfirmationsSetting value="0" id="Add" />
<ConfirmationsSetting value="0" id="Remove" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_1_3" assert-keyword="false" jdk-15="false" />
</project>

8
.idea/modules.xml generated
View File

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/resolve.iml" filepath="$PROJECT_DIR$/.idea/resolve.iml" />
</modules>
</component>
</project>

8
.idea/resolve.iml generated
View File

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="false">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

6
.idea/vcs.xml generated
View File

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="" vcs="" />
</component>
</project>

1260
.idea/workspace.xml generated
View File

File diff suppressed because it is too large Load Diff

93
_config.yml Normal file
View File

@ -0,0 +1,93 @@
# the audience for this site. even if you're not single sourcing, you still need to define an audience here.
audience: designer
# your project's title. appears in the top nav home button.
title: Jekyll for Designers
# currently the version is used only in the print cover
version: 2.0
# appears above the sidebar (optional)
tagline: Guide for designers
# leave the url empty so that you can upload the files into any domain. You just need to define the baseurl.
# url: "http://idratherbewriting.com"
# the subpath of your site. If you're publishing to the root directory, just type "". Usually set this as your project name.
baseurl: "/documentation-theme-jekyll/designer"
# this is how you will preview the site on your local machine. leave as is.
host: 127.0.0.1
# specified here in case you have multiple sites and want to view them simultaneously in different tabs (you'll need different ports)
port: 4006
# Add a feedback email for the top navigation bar
feedback_email: tomjohnson1492@gmail.com
# whether you want the sidebar to use an accordion, so that other sections in the toc collapse when one section expands.
sidebar_accordion: true
# Disqus shortname for commenting features. leave blank if you don't want a comment form.
disqus_shortname: idrbwjekyll
# Insert your google analytics tracking number. leave blank if you don't want google analytics integration.
google_analytics: UA-408430-5
markdown: redcarpet
# options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear.
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"]
# pygments requires you to install a gem on your machine. if you don't want this, use rouge instead.
highlighter: pygments
# put all files or directories that you want to exclude from your project here.
exclude:
- _drafts
- bower_components
- .idea
- _site
# these are defaults that get applied to each page or post's frontmatter. leave as is.
permalink: :title
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: true
search: true
-
scope:
path: ""
type: "posts"
values:
layout: "post"
comments: true
search: true
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
tooltip: true
search: true
sass:
sass_dir: _sass
# this enables the tooltip collection.
collections:
tooltips:
output: true
# if you want to show a label on each page indicating the audience that can see the content, put true here.
show_audience_label: true
# is this a print build? if so, put true. otherwise, false.
print: false

14
_data/sidebar.yml
View File

@ -91,6 +91,10 @@ entries:
audience: writer, designer
print: true
- title: Navtabs
url: /navtabs/
audience: writer, designer
print: true
- title: Single Sourcing
audience: writer, designer
@ -117,7 +121,13 @@ entries:
print: true
items:
- title: Build Arguments
- title: Configuration files
url: /config_setup/
audience: writer, designer
print: true
- title: Build arguments
url: /build_arguments/
audience: writer, designer
print: true
@ -127,7 +137,7 @@ entries:
audience: writer, designer
print: true
- title: Creating a Help API
- title: Creating a help API
url: /help_api/
audience: writer, designer
print: true

4
_includes/footer.html
View File

@ -1,9 +1,9 @@
<footer>
<div class="row">
<div class="col-lg-12 footer">
<a href="{{ "/copyright" | prepend: site.baseurl }}">&copy;2015 AdTruth</a>. All rights reserved. <br />
<a href="{{ "/copyright" | prepend: site.baseurl }}">&copy;2015 Your Company</a>. All rights reserved. <br />
<p>Site last generated: {{ site.time | date: "%b %-d, %Y" }} <br />
<p><img src="{{ "/41stlogo.jpeg" | prepend: site.baseurl }}"/></p>
<p><img src="{{ "/images/jekyll.png" | prepend: site.baseurl }}"/></p>
</div>
</div>
</footer>

35
_includes/pagemetadata.html Normal file
View File

@ -0,0 +1,35 @@
<!-- start page metadata -->
{% unless page.metadata == false %}
<div class="pageMetadata">
<div class="pageMetadataTitle">Table of Contents</div>
{% include toc.html %}
<hr/>
{% if page.tags != null or page.audience != null or page.last_updated != null %}
<div class="pageMetadataTitle">Page Information</div>
{% endif %}
{% if page.tags != null %}
<div class="metadataRow"><span class="tagTitle">Tags:</span>
{% for tag in page.tags %}
{% if site.data.tags.allowed-tags contains tag %}
<a href="{{ "/tag-" | prepend: site.baseurl | append: {{tag}}/index.html ">{{tag}}</a>{% unless forloop.last %}, {% endunless%}
{% endif %}
{% endfor %}
{% endif %}
</div>
{% if site.show_audience_label == true and page.audience != null %}
<div class="metadataRow"><span class="tagTitle">Audience:</span>
{% for audience in page.audience %}
{{audience}} {% unless forloop.last %}, {% endunless%}
{% endfor %}
{% endif %}</div>
{% if page.last_updated != null %}
<p><div class="metadataRow"><span class="tagTitle">Last updated:</span> {{page.last_updated}}</div></p>
{% endif %}
</div>
{% endunless %}
<!-- end pageMetadata -->

55
_layouts/page.html
View File

@ -2,54 +2,21 @@
layout: default
comments: true
---
<div class="post-header">
<h1 class="post-title-main">{{ page.title }}</h1>
<h1 class="post-title-main">{{ page.title }}</h1>
{% include pagemetadata.html %}
<div class="post-content">
{% unless page.metadata == false %}
<p>
<div class="pageMetadata">
<div class="pageMetadataTitle">Table of Contents</div>
{% include toc.html %}
<hr/>
<div class="pageMetadataTitle">Page Information</div>
{% if page.tags != null %}
<span class="metadataRow">Tags: </span>
{% for tag in page.tags %}
{% if site.data.tags.allowed-tags contains tag %}
<a href="{{ "/tag-" | prepend: site.baseurl | append: {{tag}}/index.html ">{{tag}}</a>{% unless forloop.last %}, {% endunless%}
{% endif %}
{% endfor %}</p>
{% if page.summary %}
<div class="summary">{{page.summary}}</div>
{% endif %}
{% if site.show_audience_label == true and page.audience != null %}
<p>
<span class="metadataRow">Audience: </span>
{% for audience in page.audience %}
{{audience}} {% unless forloop.last %}, {% endunless%}
{% endfor %}
</p>
{% endif %}
{{content}}
{% if page.last_updated != null %}
<p><span class="metadataRow">Last updated: </span>{{page.last_updated}}</p>
{% endif %}
{% include disqus.html %}
</div> <!-- end pageMetadata -->
{% endunless %}
</div>
<div class="post-content">
{% if page.summary %}
<div class="summary">{{page.summary}}</div>
{% endif %}
{{ content }}
{% if site.disqus %}
{% include disqus.html %}
{% endif %}
</div>
<!-- Footer -->
{% include footer.html %}
<!-- Footer -->
{% include footer.html %}

18
configs/config_designer.yml
View File

@ -2,7 +2,7 @@
audience: designer
# your project's title. appears in the top nav home button.
title: Jekyll for Designers 2.0
title: Jekyll for Designers
# currently the version is used only in the print cover
version: 2.0
@ -10,8 +10,8 @@ version: 2.0
# appears above the sidebar (optional)
tagline: Guide for designers
# the base hostname & protocol for your site (everything at the .com or .org and before)
url: "http://idratherbewriting.com"
# leave the url empty so that you can upload the files into any domain. You just need to define the baseurl.
# url: "http://idratherbewriting.com"
# the subpath of your site. If you're publishing to the root directory, just type "". Usually set this as your project name.
baseurl: "/documentation-theme-jekyll/designer"
@ -25,7 +25,7 @@ port: 4007
# Add a feedback email for the top navigation bar
feedback_email: tomjohnson1492@gmail.com
# whether you want the sidebar to use an accordion, such that other sections collapse when one expands.
# whether you want the sidebar to use an accordion, so that other sections in the toc collapse when one section expands.
sidebar_accordion: true
# Disqus shortname for commenting features. leave blank if you don't want a comment form.
@ -39,6 +39,8 @@ markdown: redcarpet
# options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear.
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"]
# pygments requires you to install a gem on your machine. if you don't want this, use rouge instead.
highlighter: pygments
# put all files or directories that you want to exclude from your project here.
@ -84,13 +86,5 @@ collections:
tooltips:
output: true
# this enables the tooltip collection.
collections:
tooltips:
output: true
# if you want to show a label on each page indicating the audience that can see the content, put true here.
show_audience_label: true
# is this a print build? if so, put true. otherwise, false.
print: false

3
configs/config_designer_pdf.yml
View File

@ -73,8 +73,5 @@ collections:
tooltips:
output: true
# if you want to show a label on each page indicating the audience that can see the content, put true here.
show_audience_label: false
# is this a print build? if so, put true. otherwise, false.
print: true

3
configs/config_writer.yml
View File

@ -83,8 +83,5 @@ defaults:
sass:
sass_dir: _sass
# if you want to show a label on each page indicating the audience that can see the content, put true here.
show_audience_label: true
# is this a print build? if so, put true. otherwise, false.
print: false

3
configs/config_writer_pdf.yml
View File

@ -73,8 +73,5 @@ collections:
tooltips:
output: true
# if you want to show a label on each page indicating the audience that can see the content, put true here.
show_audience_label: false
# is this a print build? if so, put true. otherwise, false.
print: true

67
css/customstyles.css
View File

@ -82,8 +82,9 @@ dt[id]{
body h1 {margin-top:40px;}
.post-content img {
max-width: 610px;
margin: 12px 0px 3px 0px;
margin: 12px 0px 3px 0px;
max-width: 100%;
}
.post-content ol li, .post-content ul li {
@ -246,9 +247,9 @@ margin: 3px;
}
div#toc ul li {
margin: 0px 0px 3px 10px;
margin: 8px 0px 8px 10px;
font-size: 90%;
list-style: none;
list-style: square;
}
div#toc ul {
background-color: whitesmoke;
@ -383,11 +384,6 @@ ul#mysidebar {
border-radius:0px;
}
#mysidebar {
min-width: 240px;
}
.nav ul li ul li a {
padding-left:20px;
}
@ -473,8 +469,8 @@ dl dd {
figcaption {
padding-bottom:12px;
padding-top:6px;
padding-bottom:12px;
padding-top:6px;
max-width: 90%;
margin-bottom:20px;
@ -599,12 +595,26 @@ a[data-toggle] {
}
.pageMetadata {
padding:13px;
margin:15px;
float:right;
border:1px solid #dedede;
background-color: whitesmoke;
width:200px;
padding:13px;
margin:15px 0px 15px 15px;
float:right;
border:1px solid #dedede;
background-color: whitesmoke;
width:200px;
}
@media (max-width: 1000px) {
.pageMetadata {
float:none;
}
}
@media (min-width: 1200px) {
.nav {
min-width: 240px;
}
}
.pageMetadataTitle {
@ -614,8 +624,9 @@ a[data-toggle] {
}
.metadataRow {
font-weight:500;
color: #555;
margin-top:10px;
margin-bottom:10px;
}
.pageMetadata p {
@ -630,4 +641,22 @@ h3 {color: #b62273; font-weight:normal; font-size:155%;}
.alert, .callout {
overflow: hidden;
}
}
.nav-tabs > li.active > a, .nav-tabs > li.active > a:hover, .nav-tabs > li.active > a:focus {
background-color: #248ec2;
color: white;
}
ol li ol li {list-style-type: lower-alpha;}
li img {clear:both; }
div#toc ul li ul li {list-style-type:none;}
.tab-content {
padding: 15px;
background-color: #FAFAFA;
}
span.tagTitle {font-weight: 500;}

31
js/customscripts.js
View File

@ -62,4 +62,35 @@ $(document).ready(function(){
$('[data-toggle="tooltip"]').tooltip({
placement : 'top'
});
});
// needed for nav tabs
// script from http://stackoverflow.com/questions/10523433/how-do-i-keep-the-current-tab-active-with-twitter-bootstrap-after-a-page-reload
$(function() {
var json, tabsState;
$('a[data-toggle="pill"], a[data-toggle="tab"]').on('shown.bs.tab', function(e) {
var href, json, parentId, tabsState;
tabsState = localStorage.getItem("tabs-state");
json = JSON.parse(tabsState || "{}");
parentId = $(e.target).parents("ul.nav.nav-pills, ul.nav.nav-tabs").attr("id");
href = $(e.target).attr('href');
json[parentId] = href;
return localStorage.setItem("tabs-state", JSON.stringify(json));
});
tabsState = localStorage.getItem("tabs-state");
json = JSON.parse(tabsState || "{}");
$.each(json, function(containerId, href) {
return $("#" + containerId + " a[href=" + href + "]").tab('show');
});
$("ul.nav.nav-pills, ul.nav.nav-tabs").each(function() {
var $this = $(this);
if (!json[$this.attr("id")]) {
return $this.find("a[data-toggle=tab]:first, a[data-toggle=pill]:first").tab("show");
}
});
});

12
pages/formatting/adding_tooltips.md
View File

@ -1,17 +1,17 @@
title: Adding tooltips
permalink: /adding_tooltips/
tags: []
keywords:
audience:
last_updated:
summary:
tags: [formatting]
keywords: popovers
audience: writers, designers
last_updated: May 8, 2015
summary: "You can add tooltips to your content. These tooltips work well for glossary definitions."
---
{% include linkrefs.html %}
=======
## permalink: /adding_tooltips/
You can add tooltips to your content. Because this theme is built on Bootstrap, you can simply use a specific attribute on an element to insert a tooltip. &nbsp;test...
Because this theme is built on Bootstrap, you can simply use a specific attribute on an element to insert a tooltip.
Suppose you have a glossary.yml file inside your _data folder. You could pull in that glossary definition like this:

105
pages/formatting/navtabs.md Normal file
View File

@ -0,0 +1,105 @@
---
title: NavTabs Demo
permalink: /navtabs/
tags: []
keywords:
audience:
last_updated:
summary: "Navtabs provide a tabbable navagation directly in your content. Navtabs are helpful for showing code samples for different programming languages."
---
{% include linkrefs.html %}
## Common uses
Navtabs are particularly useful for scenarios where you want to show a variety of options, such as code samples for Java, .NET, or PHP, on the same page.
While you could resort to single-source publishing to provide different outputs for each unique programming language or role, you could also use navtabs to allow users to select the content you want.
Navtabs are better for SEO since you avoid duplicate content and drive users to the same page.
## Navtabs demo
The following is a demo of a navtab. Refresh your page to see the tab you selected remain active.
<ul id="profileTabs" class="nav nav-tabs">
<li class="active"><a href="#profile" data-toggle="tab">Profile</a></li>
<li><a href="#about" data-toggle="tab">About</a></li>
<li><a href="#match" data-toggle="tab">Match</a></li>
</ul>
<div class="tab-content">
<div role="tabpanel" class="tab-pane active" id="profile">
<h2>Profile</h2>
<p>Praesent sit amet fermentum leo. Aliquam feugiat, nibh in u ltrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus.</p>
</div>
<div role="tabpanel" class="tab-pane" id="about">
<h2>About</h2>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in u ltrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus.about</p></div>
<div role="tabpanel" class="tab-pane" id="match">
<h2>Match</h2>
<p>Vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus.</p>
</div>
</div>
## Code
Here's the code for the above (with the filler text abbreviated):
```html
<ul id="profileTabs" class="nav nav-tabs">
<li class="active"><a href="#profile" data-toggle="tab">Profile</a></li>
<li><a href="#about" data-toggle="tab">About</a></li>
<li><a href="#match" data-toggle="tab">Match</a></li>
</ul>
<div class="tab-content">
<div role="tabpanel" class="tab-pane active" id="profile">
<h2>Profile</h2>
<p>Praesent sit amet fermentum leo....</p>
</div>
<div role="tabpanel" class="tab-pane" id="about">
<h2>About</h2>
<p>Lorem ipsum ...</p></div>
<div role="tabpanel" class="tab-pane" id="match">
<h2>Match</h2>
<p>Vel vehicula ....</p>
</div>
</div>
```
## Design constraints
Bootstrap automatically clears any floats after the navtab. If you have a navtab that appears in the same space as pagemetadata floating column, there will be a big space after the navtab until the end of the pagemetadata element because there's a `clear: float` property applied after the nav class.
If you change the `clear:float` property, the first heading/text on the tab will suddenly float along side the tab, which is unfortunate.
## Appearance in the mini-TOC
If you put a heading in the navtab content, that heading will appear in the mini-TOC as long as the heading tag has an ID. If you don't want the headings for each navtab section to appear in the mini-TOC, simply omit the ID attribute from the heading tag. Without this attribute, the mini-TOC won't insert the heading title into the mini-TOC.
## Must use HTML
You must use HTML within the navtab content because each navtab section is surrounded with HTML, and you can't use Markdown inside of HTML.
## Match up ID tags
Each tab's `href` attribute must match the `id` attribute of the tab content's `div` section. So if your tab has `href="#acme"`, then you add `acme` as the ID attribute in `<div role="tabpanel" class="tab-pane" id="acme">`.
One of the tabs needs to be set as active, depending on what tab you want to be open by default (usually the first one).
```html
<div role="tabpanel" class="tab-pane active" id="acme">
```
## Sets a cookie
The navtabs are part of Bootstrap, but this theme sets a cookie to remember the last tab's state. The js/customscripts.js file has a long chunk of JavaScript that sets the cookie. The JavaScript comes from [this StackOverflow thread](http://stackoverflow.com/questions/10523433/how-do-i-keep-the-current-tab-active-with-twitter-bootstrap-after-a-page-reload).
By setting a cookie, if the user refreshes the page, the active tab is the tab the user last selected (rather than defaulting to the default active tab).
## Functionality to implement
One piece of functionality I'd like to implement is the ability to set site-wide nav tab options. For example, if the user always chooses PHP instead of Java in the code samples, it would be great to set this option site-wide by default. However, this functionality isn't yet coded.

61
pages/publishing/configuration_file.md Normal file
View File

@ -0,0 +1,61 @@
---
title: Setting up the configuration file
permalink: /config_setup/
tags: []
keywords:
audience:
last_updated:
summary: "The configuration file contains important settings for your project. Some of the values you set here affect the display and functionality of the theme."
---
{% include linkrefs.html %}
## Importance of Configuration File
The configuration file serves important functions with single sourcing. Usually for each site output, you create a unique configuration file for that output.
The configuration file contains all the settings and other details unique to that site build, such as variables, titles, output directories, build folders, and more.
## Configuration File Options
Some of the options you can set in the configuration file determine theme settings. For sample values, see the default configuration file.
Note that you can arbitrary key value pairs in the configuration file, and then you can access them through `site.yourkey`. However, the values in these tables are used to control different aspects of the theme.
| Field | Description |
|-------|-----------|
| **title** | Appears in the top navigation bar as the link to home |
| **version** | Appears next to the title |
| **tagline** | Appears at the top of the left navigation bar |
| **url** | Optional. Recommended to not include this, since it allows you to easily push help from one domain to another (such as from a test environment to a production environment. As long as the baseurl's folder remains the same, the help will display well. I think the only use for the url is for the RSS feed. |
| **baseurl** | Everything that comes after the domain (acme.com). If you publish at acme.com/folder/version/role, then the baseurl is folder/version/role. Jekyll is hard-coded to only display properly when placed inside this baseurl folder. |
| **port** | The port used in the preview mode. This is only for the live preview and doesn't affect the published output. |
| **feedback_email** | Gets configured as the email address in the Send Feedback button in the top navigation bar. |
| **sidebar_accordion** | Boolean. Whether you want the navigation sidebar to use the accordion effect or not. The accordion effect means when you expand a section, the other sections auto-collapse. If you put false, then you can expand multiple sections at once. At the bottom of the navigation sidebar, two links will appear: Collapse All and Expand All. |
| **disqus_shortname** | The disqus site shortname, which is used for comments. If you don't want comment forms via disqus, leave this blank or omit altogether. |
| **markdown** | The processer to use for Markdown. This is a Jekyll-specific setting. |
| **redcarpet** | Extensions used with redcarpet. You can read more about them by searching for redcarpet extensions online. Make sure you leave the `with_toc_data` option included. This auto-creates an ID for each Markdown-formatted heading, which then gets injected into the mini-TOC. Without this auto-creation of IDs, the mini-TOC won't include the heading. If you ever use HTML formatting for headings, you need to manually add an ID attribute to the heading in order for the heading to appear in the mini-TOC. |
| **highlighter** | The syntax highlighter used. Rouge is also an option. I think Pygments does a better job. You will need to [install Pygments](http://pygments.org/download/) on your machine or else you will see an error. |
| **exclude** | A list of files and directories that you want excluded from the build. By default, all the content in your project is included in the output. |
| **permalink** | The structure used for the link URLs. To read more about permalinks, see [Permalinks](http://jekyllrb.com/docs/permalinks/). |
| **defaults** | Here you can set default values for frontmatter based on the content type (page, post, or collection). |
| **sass** | The directory for sass files. This is a Jekyll-specific settings. Sass isn't customized in this theme. |
| **collections** | Any specific collections (custom content types that extend beyond pages or posts) that you want to define. This theme defines a collection called tooltips. You access this collection by using site.tooltips instead of site.pages or site.posts. Put the tooltip content types inside a folder in your project called \_tooltips.
| **print** | Boolean. Whether this build is a print build or not. This setting allows you to run conditions in your content such as {% raw %} {% if site.print == true %} do this... {% endif %} {% endraw %}. |
## Where to store configuration files
If you have a lot of different site builds (perhaps because you're single sourcing many different outputs), you'll probably want to group the configuration files into a specific folder.
In this theme, the configuration files are grouped inside the configs folder. There are some build scripts in the root directory that simply reference the configuration files.
## Default config in root
There is also a default \_config.yml file in root that is a copy of the config_designer.yml file. This file is included so that Github Pages will build the theme.
It's also included because most Jekyll users are accustomed to downloading a theme, running `jekyll serve`, and expecting the site to build. The `jekyll serve` command depends on having a _config.yml file in the root.

4
tagindex.html
View File

@ -5,13 +5,13 @@ permalink: /tagindex/
search: false
related_pages: none
---
{% comment %} i think there's something wrong in this file.{% endcomment %}
{% capture site_tags %}{% for tag in site.tags %}{{ tag | first }}{% unless forloop.last %},{% endunless %}{% endfor %}{% endcapture %}
{% assign tags_list = site_tags | split:',' | sort %}
{% for item in (0..site.tags.size) %}{% unless forloop.last %}
{% for item in (0.site.tags.size) %}{% unless forloop.last %}
{% capture this_word %}{{ tags_list[item] | strip_newlines }}{% endcapture %}
<h2 id="{{ this_word }}">{{ this_word }}</h2>
<ul class="post-list">