content updates

This commit is contained in:
Tom Johnson 2015-08-12 18:45:08 -07:00
parent 2a81d2a101
commit e19638e498
48 changed files with 187 additions and 181 deletions

View File

@ -384,6 +384,13 @@ entries:
version: all version: all
product: all product: all
- title: Content types pages
url: /doc_tag-content-types.html
audience: writers, designers
platform: all
version: all
product: all
- title: Publishing pages - title: Publishing pages
url: /doc_tag-publishing.html url: /doc_tag-publishing.html
audience: writers, designers audience: writers, designers

View File

@ -1,9 +1,9 @@
allowed-tags: allowed-tags:
- getting-started - getting-started
- content-types
- navigation - navigation
- formatting - formatting
- publishing - publishing
- single-sourcing - single-sourcing
- special-layouts - special-layouts
- content types

View File

@ -1,10 +1,9 @@
--- ---
title: About this theme title: About this theme
tags: [] keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements
keywords: last_updated: August 12, 2015
audience: writer, designer tags: [getting-started]
last_updated: summary: "I use this theme for sophisticated single-sourcing projects that I work on as a professional technical writer."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
@ -12,9 +11,9 @@ My name is Tom Johnson, and I'm a technical writer, blogger, and podcaster based
I'm using this theme for my documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free. I'm using this theme for my documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free.
I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. But it's completely empowering as well!
By having a completely open architecture and code, there are more points of risk. At the same time, it's much easier to modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code. With a completely open architecture and code base, you can modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code.
If there's a feature you need but it isn't available here, let me know and I might add it. Alternatively, if you fork the theme, I would love to see your modifications and enhancements. If there's a feature you need but it isn't available here, let me know and I might add it. Alternatively, if you fork the theme, I would love to see your modifications and enhancements.

View File

@ -1,13 +1,13 @@
--- ---
title: Tooltips title: Tooltips
tags: [formatting] tags: [formatting]
keywords: popovers keywords: popovers, tooltips, user interface text, glossaries, definitions
audience: writers, designers last_updated: August 12, 2015
last_updated: May 13, 2015 summary: "You can add tooltips to any word, such as an acronym or specialized term. Tooltips work well for glossary definitions, because you don't have to keep repeating the definition, nor do you assume the reader already knows the word's meaning."
summary: "You can add tooltips to your content. These tooltips work well for glossary definitions."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## Creating tooltips
Because this theme is built on Bootstrap, you can simply use a specific attribute on an element to insert a tooltip. 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: Suppose you have a glossary.yml file inside your \_data folder. You could pull in that glossary definition like this:

View File

@ -1,13 +1,13 @@
--- ---
title: Alerts title: Alerts
audience: writer, designer tags: [formatting]
tags: formatting keywords: notes, tips, cautions, warnings, admonitions
keywords: last_updated: August 12, 2015
last_updated: summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes are stored as shortcodes made available through the linksrefs.hmtl include."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About alerts
Alerts are little warnings, info, or other messages that you have called out in special formatting. In order to use these alerts or callouts, put this include at the top of your page, just below your frontmatter: Alerts are little warnings, info, or other messages that you have called out in special formatting. In order to use these alerts or callouts, put this include at the top of your page, just below your frontmatter:
{%raw%} {%raw%}

View File

@ -1,10 +1,9 @@
--- ---
title: Build arguments title: Build arguments
tags: [publishing] tags: [publishing]
audience: writer, designer keywords: building, serving, serve, build
keywords: last_updated: August 12, 2015
last_updated: summary: "When you have a single sourcing project, you use more advanced arguments when you're building or serving your Jekyll sites. These arguments specify a particular configuration file and may build on other configuration files."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,10 +1,9 @@
--- ---
title: Collections title: Collections
tags: [] tags: [content-types]
keywords: keywords: groups, api, structure
audience: last_updated: August 12, 2015
last_updated: summary: "Collections are useful if you want to loop through a special folder of pages that you make available in a content API. You could also use collections if you have a set of articles that you want to treat differently from the other content, with a different layout or format."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,15 +1,17 @@
--- ---
title: Conditional logic title: Conditional logic
tags: [single-sourcing] tags: [single-sourcing]
audience: writer, designer keywords: if else logic, conditions, conditional attributes, conditional filtering
keywords: last_updated: August 12, 2015
last_updated: summary: "You can implement advanced conditional logic that includes if statements, or statements, unless, and more. This conditional logic facilitates single sourcing scenarios in which you're outputting the same content for different audiences."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About Liquid and conditional statements
If you want to create different outputs for different audiences, you can do all of this using a combination of Jekyll's Liquid markup and values in your configuration file. If you want to create different outputs for different audiences, you can do all of this using a combination of Jekyll's Liquid markup and values in your configuration file.
You can then incorporate conditional statements that check the values in the configuration files.
{{tip}} Definitely check out <a href="http://docs.shopify.com/themes/liquid-documentation/basics">Liquid's documentation</a> for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site.{{end}} {{tip}} Definitely check out <a href="http://docs.shopify.com/themes/liquid-documentation/basics">Liquid's documentation</a> for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site.{{end}}
## Where to store filtering values ## Where to store filtering values

View File

@ -1,8 +1,9 @@
--- ---
title: Configuration settings title: Configuration settings
tags: [] tags: [single-sourcing, publishing]
keywords: keywords: configuration, config, publishing options, outputs, projects
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." last_updated: August 12, 2015
summary: "The configuration file contains important settings for your project. Some of the values you set here affect &mdash; especially the product, platform, audience, and version &mdash; the display and functionality of the theme."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,13 +1,13 @@
--- ---
title: Content reuse title: Content reuse
tags: single-sourcing tags: [single-sourcing]
audience: writer, designer keywords: includes, conref, dita, transclusion, transclude, inclusion, reference
keywords: last_updated: August 12, 2015
last_updated: summary: "You can reuse chunks of content by storing these files in the includes folder. You then choose to include the file where you need it. This works similar to conref in DITA, except that you can include the file in any content type."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About content reuse
You can embed content from one file inside another using includes. Put the file containing content you want to reuse (e.g., mypage.html) inside the \_includes folder, and then use a tag like this: You can embed content from one file inside another using includes. Put the file containing content you want to reuse (e.g., mypage.html) inside the \_includes folder, and then use a tag like this:
{% raw %} {% raw %}

View File

@ -1,13 +1,13 @@
--- ---
title: Excluding files title: Excluding files
tags: single-sourcing tags: [single-sourcing]
audience: writer, designer last_updated: August 12, 2015
keywords: keywords: exclusion, separating outputs, removing files from outputs
last_updated: summary: "By default, all the files in your Jekyll project are included in the output (this differs from DITA projects, which don't include files unless noted on the map). If you're single sourcing, you'll need to exclude the files that shouldn't be included in the output. The sidebar doesn't control inclusion or exclusion."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About exclusion
By default, all files in your project are included in your output (regardless of whether they're listed in the sidebar_doc.yml file or not). To exclude files, note them in the `exclude` section in the configuration file. Here's a sample: By default, all files in your project are included in your output (regardless of whether they're listed in the sidebar_doc.yml file or not). To exclude files, note them in the `exclude` section in the configuration file. Here's a sample:
``` ```

View File

@ -1,10 +1,9 @@
--- ---
title: FAQ title: FAQ
tags: special-layouts tags: [special-layouts]
audience: writer, designer keywords: frequently asked questions, FAQ, question and answer, collapsible sections, expand, collapse
audience: last_updated: August 12, 2015
last_updated: summary: "You can use an accordion-layout that takes advantage of Bootstrap styling. This is useful for an FAQ page."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,14 +1,13 @@
--- ---
title: Generating PDF title: Generating PDF
tags: publishing tags: [publishing, single-sourcing, content-types]
keywords: keywords: PDF, prince, prince XML, ant, xsl fo
audience: last_updated: August 12, 2015
last_updated: summary: "You can generate a PDF from your Jekyll project. You do this by creating a web version of your project that is printer friendly. You then use utility called Prince to iterate through the pages and create a PDF from them. It works quite well and gives you complete control to customize the PDF output through CSS, including page directives and dynamic tags from Prince."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## Overview ## PDF overview
This process for creating a PDF relies on Prince XML to transform the HTML content into PDF. Prince costs about $500 per license. That might seem like a lot, but if you're creating a PDF, you're probably working for a company that sells a product, so you likely have access to some resources. This process for creating a PDF relies on Prince XML to transform the HTML content into PDF. Prince costs about $500 per license. That might seem like a lot, but if you're creating a PDF, you're probably working for a company that sells a product, so you likely have access to some resources.
The basic approach is to generate a list of all pages that need to be added to the PDF, and then add leverage Prince to package them up into a PDF. The basic approach is to generate a list of all pages that need to be added to the PDF, and then add leverage Prince to package them up into a PDF.

View File

@ -1,10 +1,9 @@
--- ---
title: Getting started with this theme title: Getting started with this theme
tags: getting-started tags: [getting-started]
audience: writer, designer keywords: start, introduction, begin, install, build, hello world,
keywords: last_updated: August 12, 2015
last_updated: summary: "To get started with this theme, first make sure you have all the prerequisites in place; then build the theme following the sample build commands. Because this theme is set up for single sourcing projects, it doesn't follow the same pattern as most Jekyll projects (which have just a _config.yml file in the root directory)."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,10 +1,9 @@
--- ---
title: Glossaries title: Glossaries
audience: writer, designer tags: [formatting, special-layouts]
tags: formatting keywords: definitions, glossaries, terms, style guide
keywords: last_updated: August 12, 2015
last_updated: summary: "Your glossary page can take advantage of definitions stored in a data file. This gives you the ability to reuse the same definition in multiple places. Additionally, you can use Bootstrap classes to arrange your definition list horizontally."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,16 +1,15 @@
--- ---
title: Help APIs and UI tooltips title: Help APIs and UI tooltips
tags: publishing tags: [publishing, single-sourcing, content-types]
audience: writer, designer last_updated: August 12, 2015
keywords: keywords: API, content API, UI text, inline help, context-sensitive help, popovers, tooltips
last_updated: summary: "You can loop through files and generate a JSON file that developers can consume like a help API. Developers can pull in values from the JSON into interface elements, styling them as popovers for user interface text. The beauty of this method is that the UI text remains in the help system and isn't hard-coded into the UI."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
You can create a help API that developers can use to pull in content. ## Full code demo of content API
## Full code demo You can create a help API that developers can use to pull in content.
For the full code demo, see the notes in the <a target="_blank" title="ToolTip Demo" href="{{ "/tooltip_demo.html" | prepend: site.baseurl }}">Tooltip Demo</a>. For the full code demo, see the notes in the <a target="_blank" title="ToolTip Demo" href="{{ "/tooltip_demo.html" | prepend: site.baseurl }}">Tooltip Demo</a>.

View File

@ -2,11 +2,13 @@
title: Links title: Links
audience: writer, designer audience: writer, designer
tags: [formatting, navigation] tags: [formatting, navigation]
summary: keywords: links, hyperlinks, cross references, related links, relationship tables
summary: "When creating links, although you can use standard HTML or Markdown, a better way to handle links is to store them as captured variables in an include file, and then reference the capture keywords for the links. This way you can update titles in one place, more easily identify broken links, and better manage your links. This approach is simliar to the keyref-style links in DITA."
last_updated: August 12, 2015
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## Link strategy ## Link strategies
One of the more difficult parts of a documentation site is keeping all the internal links accurate and valid. Although there are many ways to create links, I'll just describe what I've found to work well. One of the more difficult parts of a documentation site is keeping all the internal links accurate and valid. Although there are many ways to create links, I'll just describe what I've found to work well.

View File

@ -1,13 +1,13 @@
--- ---
title: Icons title: Icons
audience: writer, designer tags: [formatting]
tags: formatting keywords: font icons, buttons, images, vectors, font awesome, glyphicons
keywords: last_updated: August 12, 2015
last_updated: summary: "You can integrate font icons through the Font Awesome and Glyphical Halflings libraries. These libraries allow you to embed icons through their libraries delivered as a link reference. You don't need any image libraries downloaded in your project."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## Font icon options
The theme has two font icon sets integrated: Font Awesome and Glyphicons Halflings. The latter is part of Bootstrap, while the former is independent. Font icons allow you to insert icons drawn as vectors from a CDN (so you don't have any local images on your own site). The theme has two font icon sets integrated: Font Awesome and Glyphicons Halflings. The latter is part of Bootstrap, while the former is independent. Font icons allow you to insert icons drawn as vectors from a CDN (so you don't have any local images on your own site).
## See Font Awesome icons available ## See Font Awesome icons available

View File

@ -1,10 +1,9 @@
--- ---
title: Images title: Images
audience: writer, designer tags: [formatting]
tags: formatting keywords: images, screenshots, vectors, svg, markdown syntax
keywords: last_updated: August 12, 2015
last_updated: summary: "You embed images using traditional HTML or Markdown syntax for images. Unlike pages, you can store images in subfolders (in this theme). This is because when pages reference the images, the references are always as subpaths, never requiring the reference to move up directories."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,13 +1,14 @@
--- ---
title: iTerm profiles title: iTerm profiles
tags: [publishing] tags: [publishing]
keywords: keywords: iterm, terminal, build shortcuts, mac
audience: last_updated: August 12, 2015
last_updated: May 13, 2015 summary: "Set up profiles in iTerm to facilitate the build process with just a few clicks. This can make it a lot easier to quickly build multiple outputs."
summary: "Set up profiles in iTerm to facilitate the build process. This can make it a lot easier to quickly build multiple outputs."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About iTerm profiles
When you're working with tech docs, a lot of times you're single sourcing multiple outputs. It can be a hassle to fire up each one of these outputs using the build files containing the shell scripts. Instead, it's easier to configure iTerm with profiles that initiate the scripts. When you're working with tech docs, a lot of times you're single sourcing multiple outputs. It can be a hassle to fire up each one of these outputs using the build files containing the shell scripts. Instead, it's easier to configure iTerm with profiles that initiate the scripts.
## Set up profiles ## Set up profiles

View File

@ -1,16 +1,12 @@
--- ---
title: Knowledge-base layout title: Knowledge-base layout
tags: special-layouts tags: [special-layouts]
keywords: keywords: knowledge base, support portal, grid, doc portal
audience: last_updated: August 12, 2015
last_updated: summary: "This shows a sample layout for a knowledge base. Each square could link to a tag archive page. In this example, font icons from Font Awesome are enlarged to a large size. You can also add captions below each icon."
summary:
metadata: false
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
This shows a sample layout for a knowledge base. Each square could link to a tag archive page. In this example, font icons from Font Awesome are enlarged to a large size. You can also add captions below each icon.
<div class="row"> <div class="row">
<div class="col-md-4"><a href="doc_tag-getting-started.html"><i class="fa fa-file-image-o fa-6x border"></i><div class="kbCaption">Getting Started</div></a></div> <div class="col-md-4"><a href="doc_tag-getting-started.html"><i class="fa fa-file-image-o fa-6x border"></i><div class="kbCaption">Getting Started</div></a></div>
<div class="col-md-4"><a href="doc_tag-navigation.html"><i class="fa fa-bar-chart-o fa-6x border"></i><div class="kbCaption">Navigation</a></div></div> <div class="col-md-4"><a href="doc_tag-navigation.html"><i class="fa fa-bar-chart-o fa-6x border"></i><div class="kbCaption">Navigation</a></div></div>
@ -23,8 +19,6 @@ This shows a sample layout for a knowledge base. Each square could link to a tag
<div class="col-md-4"><a href="doc_tag-formatting.html"><i class="fa fa-cloud fa-6x border"></i><div class="kbCaption">Formatting</div></a></div> <div class="col-md-4"><a href="doc_tag-formatting.html"><i class="fa fa-cloud fa-6x border"></i><div class="kbCaption">Formatting</div></a></div>
</div> </div>
## Generating a list of all pages with a certain tag ## Generating a list of all pages with a certain tag
If you don't want to link to a tag archive index, but instead want to list all pages that have a certain tag, you could use this code: If you don't want to link to a tag archive index, but instead want to list all pages that have a certain tag, you could use this code:

View File

@ -1,14 +1,14 @@
--- ---
title: Labels title: Labels
audience: writer, designer tags: [formatting]
tags: formatting keywords: labels, buttons, bootstrap, api methods
keywords: last_updated: August 12, 2015
last_updated: summary: "Labels are just a simple Bootstrap component that you can include in your pages as needed. They represent one of many Bootstrap options you can include in your theme."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
These labels might come in handy for labeling things, such as POST, DELETE, UPDATE methods for endpoints. You can use any classes from Bootstrap in your content. ## About labels
Labels might come in handy for adding button-like tags next to elements, such as POST, DELETE, UPDATE methods for endpoints. You can use any classes from Bootstrap in your content.
```html ```html
<span class="label label-default">Default</span> <span class="label label-default">Default</span>

View File

@ -1,10 +1,9 @@
--- ---
title: NavTabs title: NavTabs
tags: [] tags: [formatting]
keywords: keywords: navigation tabs, hide sections, tabbers, interface tabs
audience: last_updated: August 12, 2015
last_updated: summary: "Navtabs provide a tab-based navagation directly in your content, allowing users to click from tab to tab to see different panels of content. Navtabs are especially helpful for showing code samples for different programming languages. The only downside to using navtabs is that you must use HTML instead of Markdown."
summary: "Navtabs provide a tabbable navagation directly in your content. Navtabs are helpful for showing code samples for different programming languages."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,10 +1,9 @@
--- ---
title: Pages title: Pages
audience: writer, designer tags: [getting-started, formatting, content-types]
tags: [getting-started, formatting] keywords: pages, authoring, exclusion, frontmatter
keywords: last_updated: August 12, 2015
last_updated: summary: "This theme uses pages only, not posts. You need to make sure your pages have the appropriate frontmatter. One frontmatter tag your users might find helpful is the summary tag. This functions similar in purpose to the shortdesc element in DITA."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
@ -35,8 +34,9 @@ Make sure each page has frontmatter at the top like this:
{% raw %} {% raw %}
--- ---
title: Your page title title: Your page title
tags: [deployment] tags: [formatting, getting-started]
keywords: overview, going live, high-level keywords: overview, going live, high-level
last_updated: August 12, 2015
summary: "Deploying DeviceInsight requires the following steps." summary: "Deploying DeviceInsight requires the following steps."
{% endraw %} {% endraw %}
--- ---

View File

@ -2,7 +2,8 @@
title: Pushing builds to server title: Pushing builds to server
tags: [publishing] tags: [publishing]
keywords: AWS, Amazon, command line, pushing build keywords: AWS, Amazon, command line, pushing build
summary: "You can push your build to AWS using commands from the command line." last_updated: August 12, 2015
summary: "You can push your build to AWS using commands from the command line. By including your copy commands in commands, you can package all of the build and deploy process into executable scripts."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,13 +1,13 @@
--- ---
title: Scroll layout title: Scroll layout
type: scroll type: scroll
audience: writer, designer keywords: json, scrolling, scrollto, jquery plugin
tags: special-layouts tags: special-layouts
last_updated: August 12, 2015
summary: "This page demonstrates how you the integration of a script called ScrollTo, which is used here to link definitions of a JSON code sample to a list of definitions for that particular term. The scenario here is that the JSON blocks are really long, with extensive nesting and subnesting, which makes it difficult for tables below the JSON to adequately explain the term in a usable way."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
<p>This page demonstrates how you the integration of a script called ScrollTo, which is used here to link definitions of a JSON code sample to a list of definitions for that particular term. The scenario here is that the JSON blocks are really long, with extensive nesting and subnesting, which makes it difficult for tables below the JSON to adequately explain the term in a usable way.</p>
{% if site.print == true %} {% if site.print == true %}
{{note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{end}} {{note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{end}}
{% endif %} {% endif %}

View File

@ -1,13 +1,13 @@
--- ---
title: Search configuration title: Search configuration
audience: writer, designer tags: [publishing, navigation]
tags: publishing keywords: search, json, configuration, findability
keywords: last_updated: August 12, 2015
last_updated: summary: "The search feature uses JavaScript to look for keyword matches in a JSON file. The results show instant matches, but it doesn't provide a search results page like Google. Also, sometimes invalid formatting can break the JSON file."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About search
The search is configured through the search.json file in the root directory. Take a look at that code if you want to change what fields are included. The search is configured through the search.json file in the root directory. Take a look at that code if you want to change what fields are included.
The search is a simple search that looks at content in pages. It looks at titles, summaries, keywords, tags, and bodies. The search is a simple search that looks at content in pages. It looks at titles, summaries, keywords, tags, and bodies.

View File

@ -1,13 +1,13 @@
--- ---
title: Series pages title: Series pages
tags: [] tags: [content-types]
keywords: series keywords: series, connected articles, tutorials, hello world
audience: writers, designers last_updated: August 12, 2015
last_updated: May 17, 2015
summary: "You can automatically link together topics belonging to the same series. This helps users know the context within a particular process." summary: "You can automatically link together topics belonging to the same series. This helps users know the context within a particular process."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## Using series for pages
You create a series by looking for all pages within a tag namespace that contain certain frontmatter. Here's a demo: {{doc_seriesdemo1_1}}. You create a series by looking for all pages within a tag namespace that contain certain frontmatter. Here's a demo: {{doc_seriesdemo1_1}}.
## 1. Create the series button ## 1. Create the series button

View File

@ -3,6 +3,7 @@ title: Series demo 1.0
summary: "This is the first post in the series." summary: "This is the first post in the series."
series: "ACME series" series: "ACME series"
weight: 1.0 weight: 1.0
last_updated: August 12, 2015
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -3,6 +3,7 @@ title: Series demo 1.1
summary: "This is the second post in the series." summary: "This is the second post in the series."
series: "ACME series" series: "ACME series"
weight: 1.1 weight: 1.1
last_updated: August 12, 2015
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -4,6 +4,7 @@ last_updated: May 17, 2015
summary: "This is the third post in the series." summary: "This is the third post in the series."
series: "ACME series" series: "ACME series"
weight: 1.2 weight: 1.2
last_updated: August 12, 2015
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -3,6 +3,7 @@ title: Series demo 1.3
summary: "This is the fourth post in the series." summary: "This is the fourth post in the series."
series: "ACME series" series: "ACME series"
weight: 1.3 weight: 1.3
last_updated: August 12, 2015
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,14 +1,12 @@
--- ---
title: Shuffle layout title: Shuffle layout
tags: special-layouts tags: [special-layouts]
type: noTags last_updated: August 12, 2015
keywords: keywords: shuffle, card layout, dynamic grid, doc portal, support portal
summary: summary: "This layout shows an example of a knowledge-base style navigation system, where there is no hierarchy, just groups of pages that have certain tags."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
This layout shows an example of a knowledge-base style navigation system, where there is no hierarchy, just groups of pages that have certain tags.
{% if site.print == true %} {% if site.print == true %}
{{note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{end}} {{note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{end}}
{% endif %} {% endif %}

View File

@ -1,9 +1,8 @@
--- ---
title: Sidebar navigation title: Sidebar navigation
audience: writer, designer
tags: [navigation] tags: [navigation]
keywords: keywords: sidebar, toc, table of contents, navigation
last_updated: last_updated: August 12, 2015
summary: "The sidebar and top navigation bar read their values from yml files. The navigation components are one of the most unique parts of this theme, since the navigation components are only included if they meet all of the product, audience, version, etc., values as specified in the project settings." summary: "The sidebar and top navigation bar read their values from yml files. The navigation components are one of the most unique parts of this theme, since the navigation components are only included if they meet all of the product, audience, version, etc., values as specified in the project settings."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,14 +1,13 @@
--- ---
title: Special layouts title: Special layouts overview
tags: special-layouts tags: [special-layouts]
keywords: keywords: layouts, information design, presentation
audience: writer, designer last_updated: August 12, 2015
last_updated: summary: "This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site. {{note}} By "layout," I'm not referring to the layouts in \_layouts in the project files. I'm referring to special ways of presenting information on the same "page" layout. {{end}}
## FAQ layout ## FAQ layout

View File

@ -1,10 +1,9 @@
--- ---
title: Support title: Support
audience: writer, designer
tags: [getting-started] tags: [getting-started]
keywords: keywords: questions, troubleshooting, contact, support
last_updated: last_updated: August 12, 2015
summary: summary: "Contact me for any support issues."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,10 +1,9 @@
--- ---
title: Supported features title: Supported features
audience: writer, designer
tags: [getting-started] tags: [getting-started]
keywords: keywords: features, capabilities, scalability, multichannel output, dita, hats, comparison, benefits
last_updated: last_updated: August 12, 2015
summary: summary: "If you're not sure whether Jekyll and this theme will support your requirements, this list provides a semi-comprehensive overview of available features."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,13 +1,13 @@
--- ---
title: Syntax highlighting title: Syntax highlighting
audience: writer, designer tags: [formatting]
tags: formatting keywords: rouge, pygments, prettify, color coding,
keywords: last_updated: August 12, 2015
last_updated: summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify."
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## About syntax highlighting
For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want: For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want:
<pre> <pre>

View File

@ -1,9 +1,10 @@
--- ---
title: Tables title: Tables
tags: [formatting] tags: [formatting]
keywords: keywords: datatables, tables, grids, markdown, multimarkdown, jquery plugins
last_updated: August 12, 2015
datatable: true datatable: true
summary: summary: "You can format tables using either multimarkdown syntax or HTML. You can also use jQuery datatables (a plugin) if you need more robust tables."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -0,0 +1,6 @@
---
title: "Content Types pages"
tagName: content-types
search: exclude
---
{% include taglogic.html %}

View File

@ -1,6 +1,9 @@
--- ---
title: Tag archives overview title: Tag archives overview
keywords: tags keywords: archives, tagging
last_updated: August 12, 2015
tags: [navigation]
summary:
--- ---
This is an overview to the tag archives section. Really the only reason this section is listed explicitly in the TOC here is to demonstrate how to add a third-level to the navigation. This is an overview to the tag archives section. Really the only reason this section is listed explicitly in the TOC here is to demonstrate how to add a third-level to the navigation.

View File

@ -2,7 +2,9 @@
title: Tags title: Tags
audience: writer, designer audience: writer, designer
tags: [navigation] tags: [navigation]
summary: last_updated: August 12, 2015
keywords: tags, navigation, buttons, links, association
summary: "Tags provide another means of navigation for your content. Unlike the table of contents, tags can show the content in a variety of arrangements and groupings. Implementing tags in this Jekyll theme is somewhat of a manual process."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,9 +1,8 @@
--- ---
title: Theme customization title: Theme customization
tags: getting-started tags: [getting-started]
audience: writer, designer last_updated: August 12, 2015
keywords: keywords: getting started, customization, beginning steps, modifying the theme, modification
last_updated:
summary: summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,9 +1,8 @@
--- ---
title: Themes title: Themes
audience: writer, designer tags: [publishing]
tags: publishing keywords: themes, styles, colors, css
keywords: last_updated: August 12, 2015
last_updated:
summary: summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,9 +1,8 @@
--- ---
title: Top navigation title: Top navigation
audience: writer, designer
tags: [navigation] tags: [navigation]
keywords: keywords: bootstrap, lists, drop-down, drop down navigation, top nav bar, topnav
last_updated: last_updated: August 12, 2015
summary: "The top navigation provides either single links or a drop-down menu. There are some other features, such as a feedback email, custom menu, and popout link." summary: "The top navigation provides either single links or a drop-down menu. There are some other features, such as a feedback email, custom menu, and popout link."
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,9 +1,8 @@
--- ---
title: Troubleshooting title: Troubleshooting
tags: [] tags: [getting-started]
keywords: keywords: trouble, problems, support, error messages, problems, failure, error, #fail
audience: last_updated: August 12, 2015
last_updated:
summary: summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}

View File

@ -1,9 +1,8 @@
--- ---
title: Video embeds title: Video embeds
audience: writer, designer tags: [formatting]
tags: formatting keywords: videos, youtube, vimeo, video js, video wrapper, mp4, stream
keywords: last_updated: August 12, 2015
last_updated:
summary: summary:
video: true video: true
--- ---

View File

@ -1,5 +1,8 @@
--- ---
title: WebStorm Text editor title: WebStorm Text editor
keywords: webstorm, sublime, markdown, atom, gnome, notepad ++, textpad, bbedit
tags: [getting-started]
last_updated: August 12, 2015
summary: summary:
--- ---