{{page.summary}}
+ {% endif %}
+
{{ content }}
+ {% if site.disqus %}
{% include disqus.html %}
+ {% endif %}
Tip: {% endcapture %}
+{% capture note %}
Note: {% endcapture %}
+{% capture important %}
Important: {% endcapture %}
+{% capture warning %}
Warning: {% endcapture %}{% capture end %}
{% endcapture %}
\ No newline at end of file
diff --git a/_includes/callouts.html b/_includes/callouts.html
new file mode 100644
index 0000000..cdae197
--- /dev/null
+++ b/_includes/callouts.html
@@ -0,0 +1,9 @@
+{% capture callout_danger %}{% endcapture %}
+{% capture callout_default %}
{% endcapture %}
+{% capture callout_primary %}
{% endcapture %}
+{% capture callout_success %}
{% endcapture %}
+{% capture callout_info %}
{% endcapture %}
+{% capture callout_warning %}
{% endcapture %}
+
+{% capture hr_faded %}
{%endcapture %} +{% capture hr_shaded %}
{%endcapture %} \ No newline at end of file diff --git a/_includes/conditions.html b/_includes/custom/conditions.html similarity index 100% rename from _includes/conditions.html rename to _includes/custom/conditions.html diff --git a/_includes/custom/links.html b/_includes/custom/links.html new file mode 100644 index 0000000..faa7530 --- /dev/null +++ b/_includes/custom/links.html @@ -0,0 +1,39 @@ + +{% comment %}{% endcomment %} +{% capture overview %}Overview{% endcapture %} +{% capture access %}Access{% endcapture %} +{% capture changepassword %}Change Password{% endcapture %} +{% capture architecture%}Architecture{% endcapture %} +{% capture performance %}Performance{% endcapture %} +{% capture deployment_process_overview %}Deployment Process Overview {% endcapture %} +{% capture delivery_models %}Delivery Models{% endcapture %} + + + +{% comment %}{% endcomment %} + +{% capture faq %}FAQ{% endcapture %} +{% capture glossary %}Glossary{% endcapture %} + + +{% comment %}{% endcomment %} +{% capture managing_users %}Managing Users{% endcapture %} +{% capture managing_customers %}Managing Customers{% endcapture %} + +{% comment %}{% endcomment %} +{% capture workflow_setup_full %}Workflow for Setting Up DI Cloud{% endcapture %} +{% capture configure_clientjs %}1. Configure Settings on the client.js Tab{% endcapture %} +{% capture configure_recipes %}2. Configure the DeviceInsight Recipes{% endcapture %} +{% capture copy_installation_scripts %}3. Copy the Installation Scripts{% endcapture %} + + +{% comment %}{% endcomment %} +{% capture setup_jsc_only %}Setting Up JSC Hosting Only{% endcapture %} + +{% capture workflow_jsc %}Workflow for JSC Hosting Only{% endcapture %} + + +{% comment %}{% endcomment %} + +{% capture viewing_logs %}Viewing Logs{% endcapture %} + diff --git a/_includes/footer.html b/_includes/footer.html index 56e281f..4406337 100755 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,12 +1,9 @@ -{% include linkrefs.html %} - \ No newline at end of file diff --git a/_includes/head.html b/_includes/head.html index dd6c0a5..ee7aabb 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,9 +1,9 @@ - - - + + +{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}
@@ -11,6 +11,7 @@
+
@@ -19,8 +20,8 @@
-
-
+
+
- {% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}
-
+
+
\ No newline at end of file
diff --git a/_includes/linkrefs.html b/_includes/linkrefs.html
index 5e8efe8..74015b4 100644
--- a/_includes/linkrefs.html
+++ b/_includes/linkrefs.html
@@ -1,65 +1,3 @@
-{% comment %}{% endcomment %}
-
-
-{% capture name %}Name{% endcapture %}
-
-{% comment %} {% endcomment %}
-{% capture getting_started %}Getting Started{% endcapture %}
-{% capture supported_features %}Supported Features{% endcapture %}
-{% capture troubleshooting %}Troubleshooting{% endcapture %}
-
-
-{% comment %} {% endcomment %}
-{% capture pages %}Pages{% endcapture %}
-{% capture alerts %}Alerts{% endcapture %}
-{% capture images %}Images{% endcapture %}
-{% capture links %}Links{% endcapture %}
-{% capture syntax_highlighting %}Syntax Highlighting{% endcapture %}
-{% capture videos %}Videos{% endcapture %}
-{% capture labels %}Labels{% endcapture %}
-{% capture icons %}Icons{% endcapture %}
-{% capture tables %}Tables{% endcapture %}
-
-{% comment %} {% endcomment %}
-
-{% capture tag-overview %}Overview pages{% endcapture %}
-{% capture tag-getting-started %}Getting started pages{% endcapture %}
-{% capture tag-single-sourcing %}Single-sourcing pages{% endcapture %}
-{% capture tag-publishing %}Publishing pages{% endcapture %}
-{% capture tag-formatting %}Formatting pages{% endcapture %}
-
-{% comment %} {% endcomment %}
-
-{% capture conditional_logic %}Conditional logic{% endcapture %}
-{% capture content_reuse %}Content re-use{% endcapture %}
-{% capture excluding_files %}Excluding files{% endcapture %}
-
-{% comment %} {% endcomment %}
-
-{% capture build_arguments %}Build arguments{% endcapture %}
-{% capture create_pdf %}Creating PDFs{% endcapture %}
-{% capture help_api %}Creating a Help API{% endcapture %}
-
-{% comment %} {% endcomment %}
-
-{% capture navigation %}Creating navigation{% endcapture %}
-{% capture tags %}Creating tags{% endcapture %}
-
-{% comment %} {% endcomment %}
-
-{% capture tip %}
{%endcapture %} +{% capture hr_shaded %}
{%endcapture %} \ No newline at end of file diff --git a/_includes/conditions.html b/_includes/custom/conditions.html similarity index 100% rename from _includes/conditions.html rename to _includes/custom/conditions.html diff --git a/_includes/custom/links.html b/_includes/custom/links.html new file mode 100644 index 0000000..faa7530 --- /dev/null +++ b/_includes/custom/links.html @@ -0,0 +1,39 @@ + +{% comment %}{% endcomment %} +{% capture overview %}Overview{% endcapture %} +{% capture access %}Access{% endcapture %} +{% capture changepassword %}Change Password{% endcapture %} +{% capture architecture%}Architecture{% endcapture %} +{% capture performance %}Performance{% endcapture %} +{% capture deployment_process_overview %}Deployment Process Overview {% endcapture %} +{% capture delivery_models %}Delivery Models{% endcapture %} + + + +{% comment %}{% endcomment %} + +{% capture faq %}FAQ{% endcapture %} +{% capture glossary %}Glossary{% endcapture %} + + +{% comment %}{% endcomment %} +{% capture managing_users %}Managing Users{% endcapture %} +{% capture managing_customers %}Managing Customers{% endcapture %} + +{% comment %}{% endcomment %} +{% capture workflow_setup_full %}Workflow for Setting Up DI Cloud{% endcapture %} +{% capture configure_clientjs %}1. Configure Settings on the client.js Tab{% endcapture %} +{% capture configure_recipes %}2. Configure the DeviceInsight Recipes{% endcapture %} +{% capture copy_installation_scripts %}3. Copy the Installation Scripts{% endcapture %} + + +{% comment %}{% endcomment %} +{% capture setup_jsc_only %}Setting Up JSC Hosting Only{% endcapture %} + +{% capture workflow_jsc %}Workflow for JSC Hosting Only{% endcapture %} + + +{% comment %}{% endcomment %} + +{% capture viewing_logs %}Viewing Logs{% endcapture %} + diff --git a/_includes/footer.html b/_includes/footer.html index 56e281f..4406337 100755 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,12 +1,9 @@ -{% include linkrefs.html %} - \ No newline at end of file diff --git a/_includes/head.html b/_includes/head.html index dd6c0a5..ee7aabb 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,9 +1,9 @@ - - - + + +
Tip: {% endcapture %}
-{% capture note %}
Note: {% endcapture %}
-{% capture important %}
Important: {% endcapture %}
-{% capture warning %}
Warning: {% endcapture %}
-{% capture end %}
{% endcapture %}
-
-{% comment %} {% endcomment %}
-{% capture callout_danger %}{% endcapture %}
-{% capture callout_default %}
{% endcapture %}
-{% capture callout_primary %}
{% endcapture %}
-{% capture callout_success %}
{% endcapture %}
-{% capture callout_info %}
{% endcapture %}
-{% capture callout_warning %}
{% endcapture %}
-
-{% capture hr_faded %}
{%endcapture %} -{% capture hr_shaded %}
{%endcapture %} \ No newline at end of file +{% include custom/links.html %} +{% include alerts.html %} +{% include callouts.html %} \ No newline at end of file diff --git a/_includes/pagination.html b/_includes/pagination.html new file mode 100644 index 0000000..ed3f824 --- /dev/null +++ b/_includes/pagination.html @@ -0,0 +1,10 @@ +
{%endcapture %} -{% capture hr_shaded %}
{%endcapture %} \ No newline at end of file +{% include custom/links.html %} +{% include alerts.html %} +{% include callouts.html %} \ No newline at end of file diff --git a/_includes/pagination.html b/_includes/pagination.html new file mode 100644 index 0000000..ed3f824 --- /dev/null +++ b/_includes/pagination.html @@ -0,0 +1,10 @@ +
-
+{% assign thisSeries = page.series %}
+{% for p in site.pages %}
+{% if p.series == thisSeries and p.permalink == page.url %}
+
- {{p.title}} +{% else %} +
- {{p.title}} +{% endif %} +{% endfor %} +
-
diff --git a/_includes/taglogic.html b/_includes/taglogic.html
index da28ee3..e65d3bb 100644
--- a/_includes/taglogic.html
+++ b/_includes/taglogic.html
@@ -7,7 +7,7 @@
{% if tag == thisTag %}
{{ page.title }}
- {% unless page.type == "noTags" %} -
-
-{% for tag in page.tags %}
-{% if site.data.tags.allowed-tags contains tag %}
-
-
-{% endif %}
-{% endfor %}
-
-
- {% if site.show_audience_label == true %}
- {% if page.audience != null %}
-
-
- {% endif %}
- {% endif %}
-Visibility
- {% if page.audience contains "writer" %}Writer {% endif %}
+{% unless page.metadata == false %}
- {% if page.audience contains "designer" %}Designer {% endif %} -
+
+
{% endunless %}
Table of Contents
+ {% include toc.html %}
+ +
Page Information
+ {% if page.tags != null %}
+
+ {% for tag in page.tags %}
+ {% if site.data.tags.allowed-tags contains tag %}
+ {{tag}}{% unless forloop.last %}, {% endunless%}
+ {% endif %}
+ {% endfor %}
+ {% endif %}
+
+ {% if site.show_audience_label == true and page.audience != null %}
+ + + {% for audience in page.audience %} + {{audience}} {% unless forloop.last %}, {% endunless%} + {% endfor %} +
+ {% endif %} + + {% if page.last_updated != null %} +{{page.last_updated}}
+ {% endif %} + +
- {% include toc.html %}
+ {% if page.summary %}
+
diff --git a/_layouts/page_print.html b/_layouts/page_print.html
index 9dd3ede..ad29518 100644
--- a/_layouts/page_print.html
+++ b/_layouts/page_print.html
@@ -11,6 +11,9 @@ comments: true
{% include toc.html %}
+ {% if page.summary %}
+
diff --git a/configs/config_designer.yml b/configs/config_designer.yml
index e63c143..312e4f9 100644
--- a/configs/config_designer.yml
+++ b/configs/config_designer.yml
@@ -20,7 +20,10 @@ baseurl: "/documentation-theme-jekyll/designer"
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: 4007
+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.
sidebar_accordion: true
@@ -55,7 +58,7 @@ defaults:
values:
layout: "page"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -63,7 +66,7 @@ defaults:
values:
layout: "post"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -71,7 +74,7 @@ defaults:
values:
layout: "page"
tooltip: true
- search: include
+ search: true
sass:
sass_dir: _sass
diff --git a/configs/config_designer_pdf.yml b/configs/config_designer_pdf.yml
index 886ba8b..4517611 100644
--- a/configs/config_designer_pdf.yml
+++ b/configs/config_designer_pdf.yml
@@ -21,6 +21,7 @@ host: 127.0.0.1
port: 4005 # specified here in case you have multiple sites and want to view them simultaneously (you'll need different ports)
+feedback_email: tomjohnson1492@gmail.com
markdown: redcarpet
@@ -46,7 +47,7 @@ defaults:
values:
layout: "page_print"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -54,7 +55,7 @@ defaults:
values:
layout: "post"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -62,7 +63,7 @@ defaults:
values:
layout: "page"
tooltip: true
- search: include
+ search: true
sass:
sass_dir: _sass
diff --git a/configs/config_writer.yml b/configs/config_writer.yml
index 518045d..b391283 100644
--- a/configs/config_writer.yml
+++ b/configs/config_writer.yml
@@ -31,6 +31,8 @@ disqus_shortname: idrbwjekyll
# Insert your google analytics tracking number. leave blank if you don't want google analytics integration.
google_analytics: UA-408430-5
+feedback_email: tomjohnson1492@gmail.com
+
markdown: redcarpet
# options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear.
@@ -60,7 +62,7 @@ defaults:
values:
layout: "page"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -68,7 +70,7 @@ defaults:
values:
layout: "post"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -76,7 +78,7 @@ defaults:
values:
layout: "page"
tooltip: true
- search: include
+ search: true
sass:
sass_dir: _sass
diff --git a/configs/config_writer_pdf.yml b/configs/config_writer_pdf.yml
index f3e49b9..e176179 100644
--- a/configs/config_writer_pdf.yml
+++ b/configs/config_writer_pdf.yml
@@ -21,6 +21,8 @@ host: 127.0.0.1
port: 4005 # specified here in case you have multiple sites and want to view them simultaneously (you'll need different ports)
+feedback_email: tomjohnson1492@gmail.com
+
markdown: redcarpet
# options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear.
@@ -45,7 +47,7 @@ defaults:
values:
layout: "page_print"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -53,7 +55,7 @@ defaults:
values:
layout: "post"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -61,7 +63,7 @@ defaults:
values:
layout: "page"
tooltip: true
- search: include
+ search: true
sass:
sass_dir: _sass
diff --git a/css/customstyles.css b/css/customstyles.css
index 6e790fa..489b62c 100644
--- a/css/customstyles.css
+++ b/css/customstyles.css
@@ -62,17 +62,7 @@
.gi-5x{font-size: 5em;}
-.fa-6x{font-size:900%;}
-.fa-7x{font-size:1100%;}
-.fa-8x{font-size:1300%;}
-.fa-9x{font-size:1500%;}
-.fa-10x{font-size:1700%;}
-i.border {
-
- padding: 10px 20px;
- background-color: whitesmoke;
-}
.breadcrumb > .active {color: #777 !important;}
@@ -91,8 +81,8 @@ dt[id]{
body h1 {margin-top:40px;}
-img {
-max-width: 650px;
+.post-content img {
+max-width: 610px;
margin: 12px 0px 3px 0px;
}
@@ -186,7 +176,7 @@ table th[class*="col-"] {
table td:first-child {
width: 150px;
- font-weight:bold;
+ /*font-weight:bold;*/
}
table tr td {
@@ -256,28 +246,32 @@ margin: 3px;
}
div#toc ul li {
-margin: 3px 18px;
+margin: 0px 0px 3px 10px;
font-size: 90%;
+list-style: none;
}
div#toc ul {
background-color: whitesmoke;
-padding: 10px;
+padding-left: 1px;
border-radius: 5px;
-list-style: square;
max-width: 300px;
-padding-top:10px;
+padding-top:3px;
color: gray;
}
div#toc ul li ul {
- padding:0px;
+ padding-left:8px;
}
+div#toc ul li ul li::before {
+ content: "– ";
+}
+
div#toc >ul::before {
- content: "Contents";
- font-weight:bold;
- color: black;
+ /*content: "Contents";*/
+ font-weight: 300;
+ color: #555;
}
li.dropdownActive a {
@@ -575,6 +569,65 @@ hr.shaded {
box-shadow: inset 0 12px 12px -12px rgba(0,0,0,0.5);
}
+.fa-6x{font-size:900%;}
+.fa-7x{font-size:1100%;}
+.fa-8x{font-size:1300%;}
+.fa-9x{font-size:1500%;}
+.fa-10x{font-size:1700%;}
+
+i.border {
+ padding: 10px 20px;
+ background-color: whitesmoke;
+}
+
a[data-toggle] {
- color: orange;
+ color: #248EC2;
+}
+
+.summary {
+ padding-left: 10px;
+ font-size:120%;
+ color: #b62273;
+ border-left:2px solid #dedede;
+ margin:20px 0px 20px 0px;
+
+}
+
+.summary:before {
+ content: "Summary: ";
+ font-weight: bold;
+}
+
+.pageMetadata {
+ padding:13px;
+ margin:15px;
+ float:right;
+ border:1px solid #dedede;
+ background-color: whitesmoke;
+ width:200px;
+}
+
+.pageMetadataTitle {
+ font-size: 16px;
+ text-align: center;
+ margin-bottom:7px;
+}
+
+.metadataRow {
+ font-weight:500;
+ color: #555;
+}
+
+.pageMetadata p {
+ line-height: 14px;
+}
+
+a.fa.fa-envelope-o.mailto {
+ font-weight: 600;
+}
+
+h3 {color: #b62273; font-weight:normal; font-size:155%;}
+
+.alert, .callout {
+ overflow: hidden;
}
\ No newline at end of file
diff --git a/css/projectstyles.css b/css/projectstyles.css
new file mode 100644
index 0000000..656c951
--- /dev/null
+++ b/css/projectstyles.css
@@ -0,0 +1,3 @@
+.navbar-inverse .navbar-collapse, .navbar-inverse .navbar-form {
+ border-color: #248ec2 !important;
+}
\ No newline at end of file
diff --git a/js/customscripts.js b/js/customscripts.js
index a3950e1..9419c09 100644
--- a/js/customscripts.js
+++ b/js/customscripts.js
@@ -30,11 +30,20 @@ function setNavigation() {
}
- });
+ $("ul.pagination a").each(function () {
+ var href = $(this).attr('href');
+ if (path.substring(0, href.length) === href) {
+ $(this).closest('li').addClass('active');
+ $(this).closest('li').parents().addClass('active');
-}
+ }
+ })
+ }
+
+)}
+
$('#mysidebar').height($(".nav").height());
// only use the affix class if the viewport is greater than 500px. otherwise it gets cut off.
@@ -42,13 +51,15 @@ $('#mysidebar').height($(".nav").height());
$( document ).ready(function() {
var h = $(window).height();
console.log (h);
- if (h > 700) {
+ if (h > 600) {
$( "#mysidebar" ).attr("class", "nav affix");
}
});
+
+
$(document).ready(function(){
$('[data-toggle="tooltip"]').tooltip({
placement : 'top'
});
-});
+});
\ No newline at end of file
diff --git a/pages/about.md b/pages/about.md
index 54b1937..2a1040f 100644
--- a/pages/about.md
+++ b/pages/about.md
@@ -1,8 +1,13 @@
---
title: About
permalink: /about/
+tags: []
+keywords:
audience: writer, designer
+last_updated:
+summary:
---
+{% include linkrefs.html %}
My name is Tom Johnson, and I'm a technical writer, blogger, and podcaster based in San Jose, California. My blog is here: [http://idratherbewriting.com](http://idratherbewriting.com). I write several posts there a week. See [my blog's about page](http://idratherbewriting.com/aboutme/) for more details about me.
diff --git a/pages/formatting/adding_tooltips.md b/pages/formatting/adding_tooltips.md
index 3d9ebcc..45a47a1 100644
--- a/pages/formatting/adding_tooltips.md
+++ b/pages/formatting/adding_tooltips.md
@@ -1,7 +1,13 @@
---
title: Adding tooltips
permalink: /adding_tooltips/
+tags: []
+keywords:
+audience:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
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.
diff --git a/pages/formatting/alerts.md b/pages/formatting/alerts.md
index 0f7fe8b..31d6f97 100644
--- a/pages/formatting/alerts.md
+++ b/pages/formatting/alerts.md
@@ -3,8 +3,12 @@ title: Alerts
permalink: /alerts/
audience: writer, designer
tags: formatting
+keywords:
+last_updated:
+summary:
---
-{% include linkrefs.html %}
+{% include linkrefs.html %}
+
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%}
diff --git a/pages/formatting/icons.md b/pages/formatting/icons.md
index efdf8d0..ff4684e 100644
--- a/pages/formatting/icons.md
+++ b/pages/formatting/icons.md
@@ -3,7 +3,12 @@ title: Icons
permalink: /icons/
audience: writer, designer
tags: formatting
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
+
The theme has two font icon sets integrated: Font Awesome and Glyphicons Halflings. The latter is part of Bootstrap, while the former is independent.
diff --git a/pages/formatting/images.md b/pages/formatting/images.md
index 626a265..57fb44a 100644
--- a/pages/formatting/images.md
+++ b/pages/formatting/images.md
@@ -3,7 +3,11 @@ title: Images
permalink: /images/
audience: writer, designer
tags: formatting
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
You embed an image the same way you embed other files or assets: you put the file into a folder, and then link to that file. The difference here is that the asset doesn't have a permalink, so here the file path actually matters.
diff --git a/pages/formatting/labels.md b/pages/formatting/labels.md
index 34ea074..ba962ab 100644
--- a/pages/formatting/labels.md
+++ b/pages/formatting/labels.md
@@ -3,7 +3,11 @@ title: Labels
permalink: /labels/
audience: writer, designer
tags: formatting
+keywords:
+last_updated:
+summary:
---
+{% 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.
diff --git a/pages/formatting/links.md b/pages/formatting/links.md
index af70ad8..9cc479b 100644
--- a/pages/formatting/links.md
+++ b/pages/formatting/links.md
@@ -3,7 +3,10 @@ title: Links
permalink: /links/
audience: writer, designer
tags: [formatting, navigation]
+last_updated:
+summary:
---
+{% include linkrefs.html %}
## Create a link
diff --git a/pages/formatting/pages.md b/pages/formatting/pages.md
index 369a694..265a7d1 100644
--- a/pages/formatting/pages.md
+++ b/pages/formatting/pages.md
@@ -3,7 +3,11 @@ title: Pages
permalink: /pages/
audience: writer, designer
tags: [getting-started, formatting]
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
Use a text editor such as Sublime Text, WebStorm, or Emacs to create pages. Make sure each page has frontmatter at the top like this:
diff --git a/pages/formatting/syntax_highlighting.md b/pages/formatting/syntax_highlighting.md
index e680c75..c915868 100644
--- a/pages/formatting/syntax_highlighting.md
+++ b/pages/formatting/syntax_highlighting.md
@@ -3,7 +3,11 @@ title: Syntax highlighting
permalink: /syntax_highlighting/
audience: writer, designer
tags: formatting
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want:
diff --git a/pages/formatting/tables.md b/pages/formatting/tables.md
index 5e0f828..04cdc36 100644
--- a/pages/formatting/tables.md
+++ b/pages/formatting/tables.md
@@ -1,7 +1,13 @@
---
title: Tables
permalink: /tables/
+tags: []
+keywords:
+audience:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
## Multimarkdown Tables
diff --git a/pages/formatting/videos.md b/pages/formatting/videos.md
index e87ef1d..34a1829 100644
--- a/pages/formatting/videos.md
+++ b/pages/formatting/videos.md
@@ -3,7 +3,11 @@ title: Videos
permalink: /videos/
audience: writer, designer
tags: formatting
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
The theme has the [video.js](http://www.videojs.com/) player integrated. But the scripts only appear on a page or post if you have certain frontmatter in that page or post. If you want to embed a video in a page and use the Video JS player, add `video: true` in your frontmatter of a page or post, and then add code like this where you want the video to appear:
diff --git a/pages/navigation/navigation.md b/pages/navigation/navigation.md
index a294c33..636748f 100644
--- a/pages/navigation/navigation.md
+++ b/pages/navigation/navigation.md
@@ -3,7 +3,11 @@ title: Navigation
permalink: /navigation/
audience: writer, designer
tags: navigation
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
The sidebar and top navigation bar read their values from yml files inside the _data folder. Follow the YML syntax shown in the file.
diff --git a/pages/navigation/tags.md b/pages/navigation/tags.md
index d043b5e..d682e6a 100644
--- a/pages/navigation/tags.md
+++ b/pages/navigation/tags.md
@@ -2,7 +2,13 @@
title: Tags
permalink: /tags/
audience: writer, designer
+tags: []
+keywords:
+audience:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
You can add tags to pages by adding `tags` in the frontmatter, like this:
diff --git a/pages/overview/getting_started.md b/pages/overview/getting_started.md
index d747869..184efed 100644
--- a/pages/overview/getting_started.md
+++ b/pages/overview/getting_started.md
@@ -3,8 +3,13 @@ title: Getting started
permalink: /getting_started/
tags: getting-started
audience: writer, designer
+keywords:
+last_updated:
+summary:
---
-{% include linkrefs.html %}
+{% include linkrefs.html %}
+
+
## Step 1: Install all the prerequisites
Before you start installing the theme, make sure you have all of these prerequisites in place.
diff --git a/pages/overview/homepage.md b/pages/overview/homepage.md
index cf8f031..44cc109 100644
--- a/pages/overview/homepage.md
+++ b/pages/overview/homepage.md
@@ -3,7 +3,11 @@ title: Documentation theme for Jekyll
permalink: "/"
audience: writer, designer
tags: getting-started
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
This is a Jekyll theme intended for documentation projects. What makes this theme unique is the approach in using Jekyll for single sourcing, that is, producing multiple outputs from the same theme. For example, you might have 3 different help systems that you're generating from the same Jekyll project files. More than anything, this Jekyll theme shows you how to use Jekyll for documentation projects from the perspective of a technical writer.
diff --git a/pages/overview/support.md b/pages/overview/support.md
index 85f62fb..f29b579 100644
--- a/pages/overview/support.md
+++ b/pages/overview/support.md
@@ -3,6 +3,10 @@ title: Support
permalink: /support/
audience: writer, designer
tags: overview
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
I'm actively developing this theme. Please let me know about any bugs or other issues that you find. Just email me at tomjohnson1492@gmail.com. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues).
\ No newline at end of file
diff --git a/pages/overview/supported_features.md b/pages/overview/supported_features.md
index 39191d8..94b1927 100644
--- a/pages/overview/supported_features.md
+++ b/pages/overview/supported_features.md
@@ -3,7 +3,11 @@ title: Supported features
permalink: /supported_features/
audience: writer, designer
tags: [overview, getting-started]
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
Before you get into exploring Jekyll as a potential platform for help content, you may be wondering if it supports some basic features. The following table shows what is supported in Jekyll.
diff --git a/pages/overview/troubleshooting.md b/pages/overview/troubleshooting.md
index ead4c5e..374da25 100644
--- a/pages/overview/troubleshooting.md
+++ b/pages/overview/troubleshooting.md
@@ -1,7 +1,13 @@
---
title: Troubleshooting
permalink: /troubleshooting/
+tags: []
+keywords:
+audience:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
## Issues building the site
diff --git a/pages/publishing/create_pdf.md b/pages/publishing/create_pdf.md
index 5ee4c13..b1643d5 100644
--- a/pages/publishing/create_pdf.md
+++ b/pages/publishing/create_pdf.md
@@ -2,8 +2,13 @@
title: Create PDF
permalink: /create_pdf/
tags: publishing
+keywords:
+audience:
+last_updated:
+summary:
---
-{% include linkrefs.html %}
+{% include linkrefs.html %}
+
{% comment %}
remaining tasks:
diff --git a/pages/publishing/help_api.md b/pages/publishing/help_api.md
index e2f8b1f..c3b652a 100644
--- a/pages/publishing/help_api.md
+++ b/pages/publishing/help_api.md
@@ -3,7 +3,11 @@ title: Create a Help API
permalink: /help_api/
tags: publishing
audience: writer, designer
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
You can create a help API that developers can use to pull in content.
diff --git a/pages/publishing/search_configuration.md b/pages/publishing/search_configuration.md
index 607323d..49321da 100644
--- a/pages/publishing/search_configuration.md
+++ b/pages/publishing/search_configuration.md
@@ -3,7 +3,11 @@ title: Search configuration
permalink: /search_configuration/
audience: writer, designer
tags: publishing
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
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 content is included.
@@ -23,7 +27,7 @@ defaults:
values:
layout: "page"
comments: true
- search: include
+ search: true
-
scope:
path: ""
@@ -31,7 +35,7 @@ defaults:
values:
layout: "post"
comments: true
- search: include
+ search: true
```
Some pages will break the JSON formatting. If that happens, then the search will no longer work. If you want to exclude a page from search add `search: exclude` in the frontmatter.
diff --git a/pages/single-sourcing/build_arguments.md b/pages/single-sourcing/build_arguments.md
index fd9daa4..6f13f68 100644
--- a/pages/single-sourcing/build_arguments.md
+++ b/pages/single-sourcing/build_arguments.md
@@ -3,7 +3,11 @@ title: Build arguments
permalink: /build_arguments/
tags: [single-sourcing, publishing]
audience: writer, designer
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
## How to build Jekyll sites
diff --git a/pages/single-sourcing/conditional_logic.md b/pages/single-sourcing/conditional_logic.md
index dd321ba..13cbb2c 100644
--- a/pages/single-sourcing/conditional_logic.md
+++ b/pages/single-sourcing/conditional_logic.md
@@ -3,7 +3,12 @@ title: Conditional logic
permalink: /conditional_logic/
tags: single-sourcing
audience: writer, designer
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
+
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.
{{tip}} Definitely check out [Liquid's documentation](http://docs.shopify.com/themes/liquid-documentation/basics) 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}}
diff --git a/pages/single-sourcing/content_reuse.md b/pages/single-sourcing/content_reuse.md
index cfc3b95..86ee81a 100644
--- a/pages/single-sourcing/content_reuse.md
+++ b/pages/single-sourcing/content_reuse.md
@@ -3,7 +3,11 @@ title: Content reuse
permalink: /content_reuse/
tags: single-sourcing
audience: writer, designer
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
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:
diff --git a/pages/single-sourcing/excluding_files.md b/pages/single-sourcing/excluding_files.md
index 5ce5c22..c95ff78 100644
--- a/pages/single-sourcing/excluding_files.md
+++ b/pages/single-sourcing/excluding_files.md
@@ -3,7 +3,11 @@ title: Excluding files and folders
permalink: /excluding_files/
tags: single-sourcing
audience: writer, designer
+keywords:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
By default, all files in your project are included in your output. To exclude files, note them in the `exclude` section in the configuration file. Here's a sample:
diff --git a/pages/special-layouts/faq.html b/pages/special-layouts/faq.html
index fc07aea..afd9389 100644
--- a/pages/special-layouts/faq.html
+++ b/pages/special-layouts/faq.html
@@ -3,7 +3,11 @@ title: FAQ
permalink: /faq/
tags: special-layouts
audience: writer, designer
+audience:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
If you want to use an FAQ format, use the syntax shown on the faq.html page.
diff --git a/pages/special-layouts/kb_layout.md b/pages/special-layouts/kb_layout.md
index 0e6d0a3..c207406 100644
--- a/pages/special-layouts/kb_layout.md
+++ b/pages/special-layouts/kb_layout.md
@@ -2,7 +2,12 @@
title: Knowledge-base homepage
permalink: /kb_layout/
tags: special-layouts
+keywords:
+audience:
+last_updated:
+summary:
---
+{% include linkrefs.html %}
This shows a sample layout for a knowledge base. Each square could link to a tag archive page.
diff --git a/pages/special-layouts/scroll.html b/pages/special-layouts/scroll.html
index 513eae7..5c449dd 100644
--- a/pages/special-layouts/scroll.html
+++ b/pages/special-layouts/scroll.html
@@ -4,7 +4,10 @@ permalink: /scroll/
type: scroll
audience: writer, designer
tags: special-layouts
+last_updated:
+summary:
---
+{% include linkrefs.html %}
{{page.summary}}
+ {% endif %}
{{ content }}
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.
diff --git a/pages/special-layouts/shuffle.html b/pages/special-layouts/shuffle.html index cc53d7a..1b8b49d 100644 --- a/pages/special-layouts/shuffle.html +++ b/pages/special-layouts/shuffle.html @@ -3,7 +3,12 @@ title: Shuffle permalink: /shuffle/ tags: special-layouts type: noTags +keywords: +audience: +last_updated: +summary: --- +{% include linkrefs.html %} diff --git a/pages/special-layouts/special_layouts.md b/pages/special-layouts/special_layouts.md index d601251..3e3b6ee 100644 --- a/pages/special-layouts/special_layouts.md +++ b/pages/special-layouts/special_layouts.md @@ -1,9 +1,13 @@ --- title: Special layouts permalink: /special_layouts/ -audience: writer, designer tags: special-layouts +keywords: +audience: writer, designer +last_updated: +summary: --- +{% 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. diff --git a/pages/tag-archives/tag-archives-overview.md b/pages/tag-archives/tag-archives-overview.md index ee6c77f..5b17b9b 100644 --- a/pages/tag-archives/tag-archives-overview.md +++ b/pages/tag-archives/tag-archives-overview.md @@ -1,6 +1,10 @@ --- title: Tag archives overview permalink: /tag-archives-overview/ +audience: customers, field engineers +tags: +keywords: tags +last_updated: May 4, 2015 --- 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. \ No newline at end of file diff --git a/pages/tag-archives/tag-formatting.html b/pages/tag-archives/tag-formatting.html index 8f18368..a7830e3 100644 --- a/pages/tag-archives/tag-formatting.html +++ b/pages/tag-archives/tag-formatting.html @@ -2,6 +2,6 @@ title: "Formatting Pages" permalink: /tag-formatting/ tagName: formatting -related_pages: false +metadata: false --- {% include taglogic.html %} \ No newline at end of file diff --git a/pages/tag-archives/tag-getting_started.html b/pages/tag-archives/tag-getting_started.html index 0da84b3..6ec80cc 100644 --- a/pages/tag-archives/tag-getting_started.html +++ b/pages/tag-archives/tag-getting_started.html @@ -2,6 +2,6 @@ title: "Getting Started Pages" permalink: /tag-getting-started/ tagName: getting-started -related_pages: false +metadata: false --- {% include taglogic.html %} \ No newline at end of file diff --git a/pages/tag-archives/tag-overview.html b/pages/tag-archives/tag-overview.html index 0413063..0f229ce 100644 --- a/pages/tag-archives/tag-overview.html +++ b/pages/tag-archives/tag-overview.html @@ -2,6 +2,6 @@ title: "Overview Pages" permalink: /tag-overview/ tagName: overview -related_pages: false +metadata: false --- {% include taglogic.html %} \ No newline at end of file diff --git a/pages/tag-archives/tag-publishing.html b/pages/tag-archives/tag-publishing.html index a68e5e9..3d10f5e 100644 --- a/pages/tag-archives/tag-publishing.html +++ b/pages/tag-archives/tag-publishing.html @@ -2,6 +2,6 @@ title: "Publishing Pages" permalink: /tag-publishing/ tagName: publishing -related_pages: false +metadata: false --- {% include taglogic.html %} \ No newline at end of file diff --git a/pages/tag-archives/tag-single-sourcing.html b/pages/tag-archives/tag-single-sourcing.html index 552326d..637cba5 100644 --- a/pages/tag-archives/tag-single-sourcing.html +++ b/pages/tag-archives/tag-single-sourcing.html @@ -1,6 +1,6 @@ --- title: "Single-Sourcing Pages" permalink: /tag-single-sourcing/ -tagName: single-sourcing +metadata: false --- {% include taglogic.html %} \ No newline at end of file diff --git a/pages/tag-archives/tag-special-layouts.html b/pages/tag-archives/tag-special-layouts.html index 29708b7..c4cd32d 100644 --- a/pages/tag-archives/tag-special-layouts.html +++ b/pages/tag-archives/tag-special-layouts.html @@ -1,6 +1,6 @@ --- title: "Special Layout Pages" permalink: /tag-special-layouts/ -tagName: special-layouts +metadata: false --- {% include taglogic.html %} \ No newline at end of file diff --git a/prince-file-list.txt b/prince-file-list.txt index a89936a..3efbdf3 100644 --- a/prince-file-list.txt +++ b/prince-file-list.txt @@ -1,8 +1,8 @@ --- layout: none -search: exclude +search: false --- -{% include conditions.html %} +{% include custom/conditions.html %} {% for entry in sidebar %} {% for subcategory in entry.subcategories %} diff --git a/search.json b/search.json index 237e8b3..19713c9 100644 --- a/search.json +++ b/search.json @@ -1,17 +1,20 @@ --- layout: none +search: false --- [ {% for page in site.pages %} - {% if page.search == "include" %} - { - "title" : "{{ page.title | escape }}", - "category" : "{{ page.category }}", - "url" : "{{ site.baseurl }}{{ page.url }}", - "date" : "{{ page.date }}", - "body": "{{ page.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}", - "excerpt": "{{ page.content | strip_html | strip_newlines | truncate: 140, '…' | replace: '\', '\\' | replace: '"', '\\"' }}" - } {% unless forloop.last %},{% endunless %} + {% if page.search == true %} + { + "title": "{{ page.title | escape }}", + "tags": "{{ page.tags }}", + "keywords": "{{page.keywords}}", + "url": "{{ site.baseurl }}{{ page.url }}", + "last_updated": "{{ page.last_updated }}", + "summary": "{{page.summary}}", + "body": "{{ page.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}" + } + {% unless forloop.last %},{% endunless %} {% endif %} {% endfor %} @@ -19,16 +22,16 @@ layout: none {% for post in site.posts %} {% if forloop.length != 0 and forloop.first %},{% endif %} - {% if post.search == "include" %} - { - "title" : "{{ post.title | escape }}", - "category" : "{{ post.category }}", - "tags" : "{{ post.tags | array_to_sentence_string }}", - "url" : "{{ site.baseurl }}{{ post.url }}", - "date" : "{{ post.date }}", - "body": "{{ post.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}", - "excerpt": "{{ post.content | strip_html | strip_newlines | truncate: 140, '…' | replace: '\', '\\' | replace: '"', '\\"' }}" - } {% unless forloop.last %},{% endunless %} + {% if post.search == true %} + { + "title": "{{ page.title | escape }}", + "tags": "{{ page.tags }}", + "keywords": "{{page.keywords}}", + "url": "{{ site.baseurl }}{{ page.url }}", + "last_updated": "{{ page.last_updated }}", + "summary": "{{page.summary}}", + "body": "{{ page.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}" + } {% unless forloop.last %},{% endunless %} {% endif %} {% endfor %} ] diff --git a/tagindex.html b/tagindex.html index 15e251f..9169067 100644 --- a/tagindex.html +++ b/tagindex.html @@ -2,7 +2,7 @@ title: Tag Index excerpt: "An archive of posts sorted by tag." permalink: /tagindex/ -search: exclude +search: false related_pages: none --- diff --git a/titlepage.html b/titlepage.html index cd8cdff..a2ed470 100644 --- a/titlepage.html +++ b/titlepage.html @@ -1,20 +1,22 @@ --- permalink: /titlepage/ +search: false --- {% comment %} this print-frontmatter class lets Prince apply a different header/footer for this page. {% endcomment %}
- 
+
{{site.print_title}}
version {{site.version}}
+ Last generated: {{ site.time | date: "%b %-d, %Y" }}