removing gh-pages branch and putting everything in master

This commit is contained in:
Tom Johnson
2015-04-20 12:10:04 -07:00
parent 8c1ccbcc57
commit f0b925337f
360 changed files with 119491 additions and 2 deletions

View File

@ -0,0 +1,20 @@
---
title: Navigation
permalink: /navigation/
audience: writer, designer
tags: navigation
---
The sidebar and top navigation bar read their values from yml files inside the _data folder. Follow the YML syntax shown in the file.
# Sidebar nav
The configuration file (configs/config_writer.yml) file includes a value (sidebar_accordion) that lets you choose whether to use the accordion feature in the sidebar or not. The accordion collapses other sections when a section is opened, which conserves space on the screen. Put `true` or `false` for the value.
You can add two levels of nesting in the sidebar nav. Follow the pattern of the existing sidebar.yml file exactly. With YML, each new level is set off with two space below it. You can't change the names of the nesting levels without also making corresponding edits to the sidebar.htm file in the _includes directory.
## Top nav
If you want the URL to point to an external site, use <code>external&#95;url</code> instead of `url`. (The sidebar.yml file doesn't have the ability to point to external sites in the nav.)
The topnav folder has two link areas: a single level link and a drop-down link. (You don't make the dropdown link by adding additional levels in the single-level.)

View File

@ -0,0 +1,45 @@
---
title: Tags
permalink: /tags/
audience: writer, designer
---
You can add tags to pages by adding `tags` in the frontmatter, like this:
```
---
title: 2.0 Release Notes
permalink: /release_notes_2_0/
tags: overview, getting-started
---
```
To prevent tags from getting out of control and inconsistent, first make sure the tag appears in the tags.yml file. If it's not there, the tag you add to a page won't be read.
Additionally, you must create a tag archive page similar to the other pages inside the pages/tag-archive folder. This theme doesn't auto-create tag archive pages.
For simplicity, make all your tags single words (connect them with hyphens if necessary).
{% if site.audience == "designer" %}
## Retrieving pages for a specific tag
If you want to retrieve pages outside of a particular tag-archive page, you could use this code:
{% raw %}
```html
{% for page in site.pages limit: 5 %}
{% for tag in page.tags %}
{% if tag == "release_notes" %}
<li><a href="{{ page.permalink | prepend: site.baseurl }}">{{page.title}}</a></li>
<div class="summary">{{page.summary}}</div>
{% endif %}
{% endfor %}
{% endfor %}
```
{% endraw %}
Tags will be sorted in alphabetical order.
{{warning}} Avoid using too many `for` loops. Each `for` loop you add increases the build time with Jekyll. This is why so many of the reuse components are inside data files rather than stored as includes in an HTML file.{{end}}
{% endif %}

45
pages/navigation/tags.md Normal file
View File

@ -0,0 +1,45 @@
---
title: Tags
permalink: /tags/
audience: writer, designer
---
You can add tags to pages by adding `tags` in the frontmatter, like this:
```
---
title: 2.0 Release Notes
permalink: /release_notes_2_0/
tags: overview, getting-started
---
```
To prevent tags from getting out of control and inconsistent, first make sure the tag appears in the tags.yml file. If it's not there, the tag you add to a page won't be read.
Additionally, you must create a tag archive page similar to the other pages inside the pages/tag-archive folder. This theme doesn't auto-create tag archive pages.
For simplicity, make all your tags single words (connect them with hyphens if necessary).
{% if site.audience == "designer" %}
## Retrieving pages for a specific tag
If you want to retrieve pages outside of a particular tag-archive page, you could use this code:
{% raw %}
```html
{% for page in site.pages limit: 5 %}
{% for tag in page.tags %}
{% if tag == "release_notes" %}
<li><a href="{{ page.permalink | prepend: site.baseurl }}">{{page.title}}</a></li>
<div class="summary">{{page.summary}}</div>
{% endif %}
{% endfor %}
{% endfor %}
```
{% endraw %}
Tags will be sorted in alphabetical order.
{{warning}} Avoid using too many `for` loops. Each `for` loop you add increases the build time with Jekyll. This is why so many of the reuse components are inside data files rather than stored as includes in an HTML file.{{end}}
{% endif %}