major updates across the theme to make it more user-centered

This commit is contained in:
Tom Johnson
2015-05-05 14:06:11 -07:00
parent a44149986a
commit 18e31994f2
67 changed files with 1048 additions and 683 deletions

2
.idea/misc.xml generated
View File

@ -10,5 +10,5 @@
<ConfirmationsSetting value="0" id="Add" /> <ConfirmationsSetting value="0" id="Add" />
<ConfirmationsSetting value="0" id="Remove" /> <ConfirmationsSetting value="0" id="Remove" />
</component> </component>
<component name="ProjectRootManager" version="2" /> <component name="ProjectRootManager" version="2" languageLevel="JDK_1_3" assert-keyword="false" jdk-15="false" />
</project> </project>

2
.idea/resolve.iml generated
View File

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

1063
.idea/workspace.xml generated

File diff suppressed because it is too large Load Diff

4
_includes/alerts.html Normal file
View File

@ -0,0 +1,4 @@
{% capture tip %}<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>{% endcapture %}
{% capture note %}<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>{% endcapture %}
{% capture important %}<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>{% endcapture %}
{% capture warning %}<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>{% endcapture %}{% capture end %}</div>{% endcapture %}

9
_includes/callouts.html Normal file
View File

@ -0,0 +1,9 @@
{% capture callout_danger %}<div class="bs-callout bs-callout-danger">{% endcapture %}
{% capture callout_default %}<div class="bs-callout bs-callout-default">{% endcapture %}
{% capture callout_primary %}<div class="bs-callout bs-callout-primary">{% endcapture %}
{% capture callout_success %}<div class="bs-callout bs-callout-success">{% endcapture %}
{% capture callout_info %}<div class="bs-callout bs-callout-info">{% endcapture %}
{% capture callout_warning %}<div class="bs-callout bs-callout-warning">{% endcapture %}
{% capture hr_faded %}<hr class="faded"/> {%endcapture %}
{% capture hr_shaded %}<hr class="shaded"/> {%endcapture %}

View File

@ -0,0 +1,39 @@
{% comment %}<!-- OVERVIEW -->{% endcomment %}
{% capture overview %}<a href="{{"/overview" | prepend: site.baseurl}}/index.html">Overview</a>{% endcapture %}
{% capture access %}<a href="{{"/access" | prepend: site.baseurl}}/index.html">Access</a>{% endcapture %}
{% capture changepassword %}<a href="{{"/changepassword" | prepend: site.baseurl}}/index.html">Change Password</a>{% endcapture %}
{% capture architecture%}<a href="{{"/architecture" | prepend: site.baseurl}}/index.html">Architecture</a>{% endcapture %}
{% capture performance %}<a href="{{"/performance" | prepend: site.baseurl}}/index.html">Performance</a>{% endcapture %}
{% capture deployment_process_overview %}<a href="{{"/deployment_process_overview" | prepend: site.baseurl}}/index.html">Deployment Process Overview </a>{% endcapture %}
{% capture delivery_models %}<a href="{{"/delivery_models" | prepend: site.baseurl}}/index.html">Delivery Models</a>{% endcapture %}
{% comment %}<!-- TOP NAV -->{% endcomment %}
{% capture faq %}<a href="{{"/faq" | prepend: site.baseurl}}/index.html">FAQ</a>{% endcapture %}
{% capture glossary %}<a href="{{"/glossary" | prepend: site.baseurl}}/index.html">Glossary</a>{% endcapture %}
{% comment %}<!-- MANAGE USERS AND CUSTOMERS-->{% endcomment %}
{% capture managing_users %}<a href="{{"/managing_users" | prepend: site.baseurl}}/index.html">Managing Users</a>{% endcapture %}
{% capture managing_customers %}<a href="{{"/managing_customers" | prepend: site.baseurl}}/index.html">Managing Customers</a>{% endcapture %}
{% comment %}<!-- FULL DI SETUP -->{% endcomment %}
{% capture workflow_setup_full %}<a href="{{"/workflow_setup_full" | prepend: site.baseurl}}/index.html">Workflow for Setting Up DI Cloud</a>{% endcapture %}
{% capture configure_clientjs %}<a href="{{"/configure_clientjs" | prepend: site.baseurl}}/index.html">1. Configure Settings on the client.js Tab</a>{% endcapture %}
{% capture configure_recipes %}<a href="{{"/configure_recipes" | prepend: site.baseurl}}/index.html">2. Configure the DeviceInsight Recipes</a>{% endcapture %}
{% capture copy_installation_scripts %}<a href="{{"/copy_installation_scripts" | prepend: site.baseurl}}/index.html">3. Copy the Installation Scripts</a>{% endcapture %}
{% comment %}<!-- JSC HOST ONLY SETUP -->{% endcomment %}
{% capture setup_jsc_only %}<a href="{{"/setup_jsc_only" | prepend: site.baseurl}}/index.html">Setting Up JSC Hosting Only</a>{% endcapture %}
{% capture workflow_jsc %}<a href="{{"/workflow_jsc" | prepend: site.baseurl}}/index.html">Workflow for JSC Hosting Only</a>{% endcapture %}
{% comment %}<!-- LOGS -->{% endcomment %}
{% capture viewing_logs %}<a href="{{"/viewing_logs" | prepend: site.baseurl}}/index.html">Viewing Logs</a>{% endcapture %}

View File

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

View File

@ -1,9 +1,9 @@
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
<link href='//fonts.googleapis.com/css?family=Montserrat:700,400' rel='stylesheet' type='text/css'> <meta name="keywords" content="{{page.tags}}{% if page.tags %}, {% endif %} {{page.keywords}}">
<link href='//fonts.googleapis.com/css?family=Merriweather:400,400italic,700,700italic' rel='stylesheet' type='text/css'> <title>{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}</title>
<link rel="stylesheet" href="{{ "/css/syntax.css" | prepend:site.baseurl }}" type='text/css'> <link rel="stylesheet" href="{{ "/css/syntax.css" | prepend:site.baseurl }}" type='text/css'>
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"> <link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
@ -11,6 +11,7 @@
<link rel="stylesheet" href="{{ "/css/lavish-bootstrap.css" | prepend:site.baseurl }}" type='text/css'> <link rel="stylesheet" href="{{ "/css/lavish-bootstrap.css" | prepend:site.baseurl }}" type='text/css'>
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}"> <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
<link rel="stylesheet" href="{{ "/css/customstyles.css" | prepend:site.baseurl }}" type='text/css'> <link rel="stylesheet" href="{{ "/css/customstyles.css" | prepend:site.baseurl }}" type='text/css'>
<link rel="stylesheet" href="{{ "/css/projectstyles.css" | prepend:site.baseurl }}" type='text/css'>
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}"> <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script> <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
@ -19,8 +20,8 @@
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="{{ "/js/toc.js" | prepend:site.baseurl }}"></script> <script src="{{ "/js/toc.js" | prepend:site.baseurl }}"></script>
<script src="{{ "/js/customscripts.js" | prepend:site.baseurl }}"></script> <script src="{{ "/js/customscripts.js" | prepend:site.baseurl }}"></script>
<link rel="shortcut icon" href="{{ "/images/favicon.ico" | prepend:site.baseurl }}" type="image/x-icon"> <link rel="shortcut icon" href="{{ "/favicon.ico" | prepend:site.baseurl }}" type="image/x-icon">
<link rel="icon" href="{{ "/images/favicon.ico" | prepend:site.baseurl }}" type="image/x-icon"> <link rel="icon" href="{{ "/favicon.ico" | prepend:site.baseurl }}" type="image/x-icon">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries --> <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// --> <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]> <!--[if lt IE 9]>
@ -28,6 +29,6 @@
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script> <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]--> <![endif]-->
<title>{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}</title>
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">

View File

@ -1,65 +1,3 @@
{% comment %}<!-- OVERVIEW -->{% endcomment %} {% include custom/links.html %}
{% include alerts.html %}
{% include callouts.html %}
{% capture name %}<a href="{{"/name" | prepend: site.baseurl}}">Name</a>{% endcapture %}
{% comment %}<!-- OVERVIEW --> {% endcomment %}
{% capture getting_started %}<a href="{{"/getting_started" | prepend: site.baseurl}}">Getting Started</a>{% endcapture %}
{% capture supported_features %}<a href="{{"/supported_features" | prepend: site.baseurl}}">Supported Features</a>{% endcapture %}
{% capture troubleshooting %}<a href="{{"/troubleshooting" | prepend: site.baseurl}}">Troubleshooting</a>{% endcapture %}
{% comment %}<!-- FORMATTING --> {% endcomment %}
{% capture pages %}<a href="{{"/pages" | prepend: site.baseurl}}">Pages</a>{% endcapture %}
{% capture alerts %}<a href="{{"/alerts" | prepend: site.baseurl}}">Alerts</a>{% endcapture %}
{% capture images %}<a href="{{"/images" | prepend: site.baseurl}}">Images</a>{% endcapture %}
{% capture links %}<a href="{{"/links" | prepend: site.baseurl}}">Links</a>{% endcapture %}
{% capture syntax_highlighting %}<a href="{{"/syntax_highlighting" | prepend: site.baseurl}}">Syntax Highlighting</a>{% endcapture %}
{% capture videos %}<a href="{{"/videos" | prepend: site.baseurl}}">Videos</a>{% endcapture %}
{% capture labels %}<a href="{{"/labels" | prepend: site.baseurl}}">Labels</a>{% endcapture %}
{% capture icons %}<a href="{{"/icons" | prepend: site.baseurl}}">Icons</a>{% endcapture %}
{% capture tables %}<a href="{{"/tables" | prepend: site.baseurl}}">Tables</a>{% endcapture %}
{% comment %}<!-- TAG ARCHIVES --> {% endcomment %}
{% capture tag-overview %}<a href="{{"/tag-overview" | prepend: site.baseurl}}">Overview pages</a>{% endcapture %}
{% capture tag-getting-started %}<a href="{{"/tag-getting-started" | prepend: site.baseurl}}">Getting started pages</a>{% endcapture %}
{% capture tag-single-sourcing %}<a href="{{"/tag-single-sourcing" | prepend: site.baseurl}}">Single-sourcing pages</a>{% endcapture %}
{% capture tag-publishing %}<a href="{{"/tag-publishing" | prepend: site.baseurl}}">Publishing pages</a>{% endcapture %}
{% capture tag-formatting %}<a href="{{"/tag-formatting" | prepend: site.baseurl}}">Formatting pages</a>{% endcapture %}
{% comment %}<!-- SINGLE SOURCING --> {% endcomment %}
{% capture conditional_logic %}<a href="{{"/conditional_logic" | prepend: site.baseurl}}">Conditional logic</a>{% endcapture %}
{% capture content_reuse %}<a href="{{"/content_reuse" | prepend: site.baseurl}}">Content re-use</a>{% endcapture %}
{% capture excluding_files %}<a href="{{"/ excluding_files" | prepend: site.baseurl}}">Excluding files</a>{% endcapture %}
{% comment %}<!-- PUBLISHING --> {% endcomment %}
{% capture build_arguments %}<a href="{{"/build_arguments" | prepend: site.baseurl}}">Build arguments</a>{% endcapture %}
{% capture create_pdf %}<a href="{{"/create_pdf" | prepend: site.baseurl}}">Creating PDFs</a>{% endcapture %}
{% capture help_api %}<a href="{{"/help_api" | prepend: site.baseurl}}">Creating a Help API</a>{% endcapture %}
{% comment %}<!-- NAVIGATION --> {% endcomment %}
{% capture navigation %}<a href="{{"/navigation" | prepend: site.baseurl}}">Creating navigation</a>{% endcapture %}
{% capture tags %}<a href="{{"/tags" | prepend: site.baseurl}}">Creating tags</a>{% endcapture %}
{% comment %}<!-- ALERTS --> {% endcomment %}
{% capture tip %}<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>{% endcapture %}
{% capture note %}<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>{% endcapture %}
{% capture important %}<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>{% endcapture %}
{% capture warning %}<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>{% endcapture %}
{% capture end %}</div>{% endcapture %}
{% comment %}<!-- CALLOUTS --> {% endcomment %}
{% capture callout_danger %}<div class="bs-callout bs-callout-danger">{% endcapture %}
{% capture callout_default %}<div class="bs-callout bs-callout-default">{% endcapture %}
{% capture callout_primary %}<div class="bs-callout bs-callout-primary">{% endcapture %}
{% capture callout_success %}<div class="bs-callout bs-callout-success">{% endcapture %}
{% capture callout_info %}<div class="bs-callout bs-callout-info">{% endcapture %}
{% capture callout_warning %}<div class="bs-callout bs-callout-warning">{% endcapture %}
{% capture hr_faded %}<hr class="faded"/> {%endcapture %}
{% capture hr_shaded %}<hr class="shaded"/> {%endcapture %}

10
_includes/pagination.html Normal file
View File

@ -0,0 +1,10 @@
<ul class="pagination">
{% assign thisSeries = page.series %}
{% for p in site.pages %}
{% if p.series == thisSeries and p.permalink == page.url %}
<li class="active"><a href="{{p.permalink | prepend: site.baseurl}}index.html">{{p.title}}</a></li>
{% else %}
<li><a href="{{p.permalink | prepend: site.baseurl}}index.html">{{p.title}}</a></li>
{% endif %}
{% endfor %}
</ul>

View File

@ -40,7 +40,7 @@ $(document).ready(function() {
</script> </script>
{% include conditions.html %} {% include custom/conditions.html %}
<ul id="mysidebar" class="nav"> <ul id="mysidebar" class="nav">

View File

@ -7,7 +7,7 @@
{% if tag == thisTag %} {% if tag == thisTag %}
<tr><td><a href="{{ page.permalink | prepend: site.baseurl | append: "index.html" }}">{{page.title}}</a></td> <tr><td><a href="{{ page.permalink | prepend: site.baseurl | append: "index.html" }}">{{page.title}}</a></td>
<td>{{ page.content | truncatewords: 50 | strip_html }}</td> <td>{% if page.summary %} {{ page.summary | strip_html | strip_newlines | truncate: 160 }} {% else %} {{ page.content | truncatewords: 50 | strip_html }} {% endif %}</td>
</tr> </tr>
{% endif %} {% endif %}
{% endfor %} {% endfor %}

View File

@ -1,3 +1,18 @@
<!-- Send feedback function -->
<script>
function SendLinkByMail(href) {
var subject= "{{site.title}} {{site.version}} documentation feedback";
var body = "I have some feedback about the {{page.title}} page: ";
body += window.location.href;
body += "";
var uri = "mailto:{{site.feedback_email}}?subject=";
uri += encodeURIComponent(subject);
uri += "&body=";
uri += encodeURIComponent(body);
window.location.href = uri;
}
</script>
<!-- Navigation --> <!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation"> <nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container topnavlinks"> <div class="container topnavlinks">
@ -8,13 +23,13 @@
<span class="icon-bar"></span> <span class="icon-bar"></span>
<span class="icon-bar"></span> <span class="icon-bar"></span>
</button> </button>
<a class="fa fa-home fa-lg navbar-brand" href="{{ "/index.html" | prepend: site.baseurl }}">&nbsp;<span class="projectTitle"> {{site.title}}</span></a> <a class="fa fa-home fa-lg navbar-brand" href="{{ "/index.html" | prepend: site.baseurl }}">&nbsp;<span class="projectTitle"> {{site.title}} {{1.0}}</span></a>
</div> </div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right"> <ul class="nav navbar-nav navbar-right">
<!-- entries without drop-downs appear here --> <!-- entries without drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.--> <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
{% include conditions.html %} {% include custom/conditions.html %}
{% for entry in topnav %} {% for entry in topnav %}
{% for subcategory in entry.subcategories %} {% for subcategory in entry.subcategories %}
@ -22,13 +37,16 @@
{% if subcategory.external_url %} {% if subcategory.external_url %}
<li><a href="{{subcategory.external_url}}" target="_blank">{{subcategory.title}}</a></li> <li><a href="{{subcategory.external_url}}" target="_blank">{{subcategory.title}}</a></li>
{% elsif page.url contains subcategory.url %} {% elsif page.url contains subcategory.url %}
<li class="active"><a href="{{subcategory.url | prepend: site.baseurl}}" class="active">{{subcategory.title}}</a></li> <li class="active"><a href="{{subcategory.url | prepend: site.baseurl}}index.html" class="active">{{subcategory.title}}</a></li>
{% else %} {% else %}
<li><a href="{{subcategory.url | prepend: site.baseurl}}">{{subcategory.title}}</a></li> <li><a href="{{subcategory.url | prepend: site.baseurl}}index.html">{{subcategory.title}}</a></li>
{% endif %} {% endif %}
{% endif %} {% endif %}
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}
{% if site.feedback_email %}<li><a class="fa fa-envelope-o mailto" href="javascript:(function()%7BSendLinkByMail()%3B%7D)()%3B"> Feedback</a></li>{% endif %}
<!-- entries with drop-downs appear here --> <!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.--> <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
@ -44,9 +62,9 @@
{% if subitem.external_url %} {% if subitem.external_url %}
<li><a href="{{subitem.external_url}}" target="_blank">{{subitem.title}}</a></li> <li><a href="{{subitem.external_url}}" target="_blank">{{subitem.title}}</a></li>
{% elsif page.url contains subitem.url %} {% elsif page.url contains subitem.url %}
<li class="dropdownActive"><a href="{{subitem.url | prepend: site.baseurl}}">{{subitem.title}}</a></li> <li class="dropdownActive"><a href="{{subitem.url | prepend: site.baseurl}}index.html">{{subitem.title}}</a></li>
{% else %} {% else %}
<li><a href="{{subitem.url | prepend: site.baseurl}}">{{subitem.title}}</a></li> <li><a href="{{subitem.url | prepend: site.baseurl}}index.html">{{subitem.title}}</a></li>
{% endif %} {% endif %}
{% endif %} {% endif %}
{% endfor %} {% endfor %}
@ -75,6 +93,8 @@
</script> </script>
<!-- end search --> <!-- end search -->
</li> </li>
</div> </div>
<!-- /.container --> <!-- /.container -->
</nav> </nav>

View File

@ -6,24 +6,12 @@
{% include head.html %} {% include head.html %}
{% if page.video == true %} {% if page.video == true %}
<link href="https://vjs.zencdn.net/4.12/video-js.css" rel="stylesheet"> <link href="https://vjs.zencdn.net/4.12/video-js.css" rel="stylesheet">
<script src="https://vjs.zencdn.net/4.12/video.js"></script> <script src="https://vjs.zencdn.net/4.12/video.js"></script>
{%comment%}
<!--
if you want the video js and css local instead of cdn, use the following code instead of the cdn links above.
-->
<link href="{{ "/js/video-js/video-js.min.css" | prepend:site.baseurl }}" rel="stylesheet" type="text/css"></link>
<script src="{{ "/js/video-js/video.js" | prepend:site.baseurl }}"></script>
<script> videojs.options.flash.swf = "{{site.baseurl}}/js/video-js/video-js.swf";</script>
{%endcomment%}
{% endif %} {% endif %}
{% if page.datatable == true %} {% if page.datatable == true %}
<link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/1.10.5/css/jquery.dataTables.css"> <link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/1.10.5/css/jquery.dataTables.css">
<script type="text/javascript" charset="utf8" src="https://cdn.datatables.net/1.10.5/js/jquery.dataTables.js"></script> <script type="text/javascript" charset="utf8" src="https://cdn.datatables.net/1.10.5/js/jquery.dataTables.js"></script>
{% endif %} {% endif %}

View File

@ -3,27 +3,20 @@
<html> <html>
<head> <head>
{% include head.html %} {% include head.html %}
{% comment %}
<script> <link rel="stylesheet" href="{{ "/css/customstyles.css" | prepend:site.baseurl }}" type='text/css'>
Prince.addScriptFunc("datestamp", function() {
return (new Date()).toString();
});
</script>
{% endcomment %}
<link rel="stylesheet" href="{{ "/css/printstyles.css" | prepend:site.baseurl }}" type='text/css'> <link rel="stylesheet" href="{{ "/css/printstyles.css" | prepend:site.baseurl }}" type='text/css'>
{% if site.audience == "writer" %} {% if site.audience == "fe" %}
<link rel="stylesheet" href="{{ "/css/print-header-writer.css" | prepend:site.baseurl }}" type='text/css'> <link rel="stylesheet" href="{{ "/css/print-header-fe.css" | prepend:site.baseurl }}" type='text/css'>
{% else if site.audience == "designer" %} {% elsif site.audience == "customer" %}
<link rel="stylesheet" href="{{ "/css/print-header-designer.css" | prepend:site.baseurl }}" type='text/css'> <link rel="stylesheet" href="{{ "/css/print-header-customer.css" | prepend:site.baseurl }}" type='text/css'>
{% elsif site.audience == "sales" %}
<link rel="stylesheet" href="{{ "/css/print-header-sales.css" | prepend:site.baseurl }}" type='text/css'>
{% endif %} {% endif %}
{% if page.datatable == true %}
<link rel="stylesheet" type="text/css" href="//cdn.datatables.net/1.10.5/css/jquery.dataTables.css">
<script type="text/javascript" charset="utf8" src="//cdn.datatables.net/1.10.5/js/jquery.dataTables.js"></script>
{% endif %}
</head> </head>
<body class="print"> <body class="print">

View File

@ -5,36 +5,49 @@ comments: true
<div class="post-header"> <div class="post-header">
<h1 class="post-title-main">{{ page.title }}</h1> <h1 class="post-title-main">{{ page.title }}</h1>
{% unless page.type == "noTags" %} {% unless page.metadata == false %}
<div class="pageTags">
{% for tag in page.tags %}
{% if site.data.tags.allowed-tags contains tag %}
<a href="{{ "/tag-" | prepend: site.baseurl | append: {{tag}}/index.html ">
<button type="button" class="btn btn-default navbar-btn">{{tag}}</button></a>
{% endif %}
{% endfor %}
</div>
{% if site.show_audience_label == true %}
{% if page.audience != null %}
<div class="audienceLabel">
<div class="prefaceAudienceLabel">Visibility</div>
{% if page.audience contains "writer" %}<span class="label label-info myLabel">Writer</span> {% endif %}
<p> <p>
{% if page.audience contains "designer" %}<span class="label label-warning">Designer</span> {% endif %} <div class="pageMetadata">
</div> <div class="pageMetadataTitle">Table of Contents</div>
{% endif %} {% include toc.html %}
{% endif %} <hr/>
</div> <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>
{% 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 %}
{% if page.last_updated != null %}
<p><span class="metadataRow">Last updated: </span>{{page.last_updated}}</p>
{% endif %}
</div> <!-- end pageMetadata -->
{% endunless %} {% endunless %}
<div class="post-content"> <div class="post-content">
{% include toc.html %} {% if page.summary %}
<div class="summary">{{page.summary}}</div>
{% endif %}
{{ content }} {{ content }}
{% if site.disqus %}
{% include disqus.html %} {% include disqus.html %}
{% endif %}
</div> </div>

View File

@ -11,6 +11,9 @@ comments: true
<div class="post-content"> <div class="post-content">
{% include toc.html %} {% include toc.html %}
{% if page.summary %}
<div class="summary">{{page.summary}}</div>
{% endif %}
{{ content }} {{ content }}
</div> </div>

View File

@ -20,7 +20,10 @@ baseurl: "/documentation-theme-jekyll/designer"
host: 127.0.0.1 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) # 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. # whether you want the sidebar to use an accordion, such that other sections collapse when one expands.
sidebar_accordion: true sidebar_accordion: true
@ -55,7 +58,7 @@ defaults:
values: values:
layout: "page" layout: "page"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -63,7 +66,7 @@ defaults:
values: values:
layout: "post" layout: "post"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -71,7 +74,7 @@ defaults:
values: values:
layout: "page" layout: "page"
tooltip: true tooltip: true
search: include search: true
sass: sass:
sass_dir: _sass sass_dir: _sass

View File

@ -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) 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 markdown: redcarpet
@ -46,7 +47,7 @@ defaults:
values: values:
layout: "page_print" layout: "page_print"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -54,7 +55,7 @@ defaults:
values: values:
layout: "post" layout: "post"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -62,7 +63,7 @@ defaults:
values: values:
layout: "page" layout: "page"
tooltip: true tooltip: true
search: include search: true
sass: sass:
sass_dir: _sass sass_dir: _sass

View File

@ -31,6 +31,8 @@ disqus_shortname: idrbwjekyll
# Insert your google analytics tracking number. leave blank if you don't want google analytics integration. # Insert your google analytics tracking number. leave blank if you don't want google analytics integration.
google_analytics: UA-408430-5 google_analytics: UA-408430-5
feedback_email: tomjohnson1492@gmail.com
markdown: redcarpet markdown: redcarpet
# options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear. # 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: values:
layout: "page" layout: "page"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -68,7 +70,7 @@ defaults:
values: values:
layout: "post" layout: "post"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -76,7 +78,7 @@ defaults:
values: values:
layout: "page" layout: "page"
tooltip: true tooltip: true
search: include search: true
sass: sass:
sass_dir: _sass sass_dir: _sass

View File

@ -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) 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 markdown: redcarpet
# options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear. # 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: values:
layout: "page_print" layout: "page_print"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -53,7 +55,7 @@ defaults:
values: values:
layout: "post" layout: "post"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -61,7 +63,7 @@ defaults:
values: values:
layout: "page" layout: "page"
tooltip: true tooltip: true
search: include search: true
sass: sass:
sass_dir: _sass sass_dir: _sass

View File

@ -62,17 +62,7 @@
.gi-5x{font-size: 5em;} .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;} .breadcrumb > .active {color: #777 !important;}
@ -91,8 +81,8 @@ dt[id]{
body h1 {margin-top:40px;} body h1 {margin-top:40px;}
img { .post-content img {
max-width: 650px; max-width: 610px;
margin: 12px 0px 3px 0px; margin: 12px 0px 3px 0px;
} }
@ -186,7 +176,7 @@ table th[class*="col-"] {
table td:first-child { table td:first-child {
width: 150px; width: 150px;
font-weight:bold; /*font-weight:bold;*/
} }
table tr td { table tr td {
@ -256,28 +246,32 @@ margin: 3px;
} }
div#toc ul li { div#toc ul li {
margin: 3px 18px; margin: 0px 0px 3px 10px;
font-size: 90%; font-size: 90%;
list-style: none;
} }
div#toc ul { div#toc ul {
background-color: whitesmoke; background-color: whitesmoke;
padding: 10px; padding-left: 1px;
border-radius: 5px; border-radius: 5px;
list-style: square;
max-width: 300px; max-width: 300px;
padding-top:10px; padding-top:3px;
color: gray; color: gray;
} }
div#toc ul li ul { div#toc ul li ul {
padding:0px; padding-left:8px;
} }
div#toc ul li ul li::before {
content: " ";
}
div#toc >ul::before { div#toc >ul::before {
content: "Contents"; /*content: "Contents";*/
font-weight:bold; font-weight: 300;
color: black; color: #555;
} }
li.dropdownActive a { li.dropdownActive a {
@ -575,6 +569,65 @@ hr.shaded {
box-shadow: inset 0 12px 12px -12px rgba(0,0,0,0.5); 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] { 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;
} }

3
css/projectstyles.css Normal file
View File

@ -0,0 +1,3 @@
.navbar-inverse .navbar-collapse, .navbar-inverse .navbar-form {
border-color: #248ec2 !important;
}

View File

@ -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()); $('#mysidebar').height($(".nav").height());
// only use the affix class if the viewport is greater than 500px. otherwise it gets cut off. // 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() { $( document ).ready(function() {
var h = $(window).height(); var h = $(window).height();
console.log (h); console.log (h);
if (h > 700) { if (h > 600) {
$( "#mysidebar" ).attr("class", "nav affix"); $( "#mysidebar" ).attr("class", "nav affix");
} }
}); });
$(document).ready(function(){ $(document).ready(function(){
$('[data-toggle="tooltip"]').tooltip({ $('[data-toggle="tooltip"]').tooltip({
placement : 'top' placement : 'top'
}); });
}); });

View File

@ -1,8 +1,13 @@
--- ---
title: About title: About
permalink: /about/ permalink: /about/
tags: []
keywords:
audience: writer, designer 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. 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.

View File

@ -1,7 +1,13 @@
--- ---
title: Adding tooltips title: Adding tooltips
permalink: /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. 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.

View File

@ -3,8 +3,12 @@ title: Alerts
permalink: /alerts/ permalink: /alerts/
audience: writer, designer audience: writer, designer
tags: formatting 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: 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

@ -3,7 +3,12 @@ title: Icons
permalink: /icons/ permalink: /icons/
audience: writer, designer audience: writer, designer
tags: formatting 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. The theme has two font icon sets integrated: Font Awesome and Glyphicons Halflings. The latter is part of Bootstrap, while the former is independent.

View File

@ -3,7 +3,11 @@ title: Images
permalink: /images/ permalink: /images/
audience: writer, designer audience: writer, designer
tags: formatting 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. 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.

View File

@ -3,7 +3,11 @@ title: Labels
permalink: /labels/ permalink: /labels/
audience: writer, designer audience: writer, designer
tags: formatting 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. 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.

View File

@ -3,7 +3,10 @@ title: Links
permalink: /links/ permalink: /links/
audience: writer, designer audience: writer, designer
tags: [formatting, navigation] tags: [formatting, navigation]
last_updated:
summary:
--- ---
{% include linkrefs.html %}
## Create a link ## Create a link

View File

@ -3,7 +3,11 @@ title: Pages
permalink: /pages/ permalink: /pages/
audience: writer, designer audience: writer, designer
tags: [getting-started, formatting] 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: 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:

View File

@ -3,7 +3,11 @@ title: Syntax highlighting
permalink: /syntax_highlighting/ permalink: /syntax_highlighting/
audience: writer, designer audience: writer, designer
tags: formatting tags: formatting
keywords:
last_updated:
summary:
--- ---
{% include linkrefs.html %}
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:

View File

@ -1,7 +1,13 @@
--- ---
title: Tables title: Tables
permalink: /tables/ permalink: /tables/
tags: []
keywords:
audience:
last_updated:
summary:
--- ---
{% include linkrefs.html %}
## Multimarkdown Tables ## Multimarkdown Tables

View File

@ -3,7 +3,11 @@ title: Videos
permalink: /videos/ permalink: /videos/
audience: writer, designer audience: writer, designer
tags: formatting 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: 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:

View File

@ -3,7 +3,11 @@ title: Navigation
permalink: /navigation/ permalink: /navigation/
audience: writer, designer audience: writer, designer
tags: navigation 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. The sidebar and top navigation bar read their values from yml files inside the _data folder. Follow the YML syntax shown in the file.

View File

@ -2,7 +2,13 @@
title: Tags title: Tags
permalink: /tags/ permalink: /tags/
audience: writer, designer 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: You can add tags to pages by adding `tags` in the frontmatter, like this:

View File

@ -3,8 +3,13 @@ title: Getting started
permalink: /getting_started/ permalink: /getting_started/
tags: getting-started tags: getting-started
audience: writer, designer audience: writer, designer
keywords:
last_updated:
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
## Step 1: Install all the prerequisites ## Step 1: Install all the prerequisites
Before you start installing the theme, make sure you have all of these prerequisites in place. Before you start installing the theme, make sure you have all of these prerequisites in place.

View File

@ -3,7 +3,11 @@ title: Documentation theme for Jekyll
permalink: "/" permalink: "/"
audience: writer, designer audience: writer, designer
tags: getting-started 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. 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.

View File

@ -3,6 +3,10 @@ title: Support
permalink: /support/ permalink: /support/
audience: writer, designer audience: writer, designer
tags: overview 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 <a href="mailto:tomjohnson1492@gmail.com">tomjohnson1492@gmail.com</a>. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues). I'm actively developing this theme. Please let me know about any bugs or other issues that you find. Just email me at <a href="mailto:tomjohnson1492@gmail.com">tomjohnson1492@gmail.com</a>. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues).

View File

@ -3,7 +3,11 @@ title: Supported features
permalink: /supported_features/ permalink: /supported_features/
audience: writer, designer audience: writer, designer
tags: [overview, getting-started] 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. 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.

View File

@ -1,7 +1,13 @@
--- ---
title: Troubleshooting title: Troubleshooting
permalink: /troubleshooting/ permalink: /troubleshooting/
tags: []
keywords:
audience:
last_updated:
summary:
--- ---
{% include linkrefs.html %}
## Issues building the site ## Issues building the site

View File

@ -2,8 +2,13 @@
title: Create PDF title: Create PDF
permalink: /create_pdf/ permalink: /create_pdf/
tags: publishing tags: publishing
keywords:
audience:
last_updated:
summary:
--- ---
{% include linkrefs.html %} {% include linkrefs.html %}
{% comment %} {% comment %}
remaining tasks: remaining tasks:

View File

@ -3,7 +3,11 @@ title: Create a Help API
permalink: /help_api/ permalink: /help_api/
tags: publishing tags: publishing
audience: writer, designer audience: writer, designer
keywords:
last_updated:
summary:
--- ---
{% include linkrefs.html %}
You can create a help API that developers can use to pull in content. You can create a help API that developers can use to pull in content.

View File

@ -3,7 +3,11 @@ title: Search configuration
permalink: /search_configuration/ permalink: /search_configuration/
audience: writer, designer audience: writer, designer
tags: publishing 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. 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: values:
layout: "page" layout: "page"
comments: true comments: true
search: include search: true
- -
scope: scope:
path: "" path: ""
@ -31,7 +35,7 @@ defaults:
values: values:
layout: "post" layout: "post"
comments: true 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. 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.

View File

@ -3,7 +3,11 @@ title: Build arguments
permalink: /build_arguments/ permalink: /build_arguments/
tags: [single-sourcing, publishing] tags: [single-sourcing, publishing]
audience: writer, designer audience: writer, designer
keywords:
last_updated:
summary:
--- ---
{% include linkrefs.html %}
## How to build Jekyll sites ## How to build Jekyll sites

View File

@ -3,7 +3,12 @@ title: Conditional logic
permalink: /conditional_logic/ permalink: /conditional_logic/
tags: single-sourcing tags: single-sourcing
audience: writer, designer 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. 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}} {{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}}

View File

@ -3,7 +3,11 @@ title: Content reuse
permalink: /content_reuse/ permalink: /content_reuse/
tags: single-sourcing tags: single-sourcing
audience: writer, designer 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: 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:

View File

@ -3,7 +3,11 @@ title: Excluding files and folders
permalink: /excluding_files/ permalink: /excluding_files/
tags: single-sourcing tags: single-sourcing
audience: writer, designer 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: 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:

View File

@ -3,7 +3,11 @@ title: FAQ
permalink: /faq/ permalink: /faq/
tags: special-layouts tags: special-layouts
audience: writer, designer 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. If you want to use an FAQ format, use the syntax shown on the faq.html page.

View File

@ -2,7 +2,12 @@
title: Knowledge-base homepage title: Knowledge-base homepage
permalink: /kb_layout/ permalink: /kb_layout/
tags: special-layouts 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. This shows a sample layout for a knowledge base. Each square could link to a tag archive page.

View File

@ -4,7 +4,10 @@ permalink: /scroll/
type: scroll type: scroll
audience: writer, designer audience: writer, designer
tags: special-layouts tags: special-layouts
last_updated:
summary:
--- ---
{% 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> <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>

View File

@ -3,7 +3,12 @@ title: Shuffle
permalink: /shuffle/ permalink: /shuffle/
tags: special-layouts tags: special-layouts
type: noTags type: noTags
keywords:
audience:
last_updated:
summary:
--- ---
{% include linkrefs.html %}
<script src="{{ "/js/jquery.shuffle.min.js" | prepend:site.baseurl }}"></script> <script src="{{ "/js/jquery.shuffle.min.js" | prepend:site.baseurl }}"></script>
<script src="{{ "/js/jquery.ba-throttle-debounce.min.js" | prepend:site.baseurl }}"></script> <script src="{{ "/js/jquery.ba-throttle-debounce.min.js" | prepend:site.baseurl }}"></script>

View File

@ -1,9 +1,13 @@
--- ---
title: Special layouts title: Special layouts
permalink: /special_layouts/ permalink: /special_layouts/
audience: writer, designer
tags: special-layouts 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. 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.

View File

@ -1,6 +1,10 @@
--- ---
title: Tag archives overview title: Tag archives overview
permalink: /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. 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,6 +2,6 @@
title: "Formatting Pages" title: "Formatting Pages"
permalink: /tag-formatting/ permalink: /tag-formatting/
tagName: formatting tagName: formatting
related_pages: false metadata: false
--- ---
{% include taglogic.html %} {% include taglogic.html %}

View File

@ -2,6 +2,6 @@
title: "Getting Started Pages" title: "Getting Started Pages"
permalink: /tag-getting-started/ permalink: /tag-getting-started/
tagName: getting-started tagName: getting-started
related_pages: false metadata: false
--- ---
{% include taglogic.html %} {% include taglogic.html %}

View File

@ -2,6 +2,6 @@
title: "Overview Pages" title: "Overview Pages"
permalink: /tag-overview/ permalink: /tag-overview/
tagName: overview tagName: overview
related_pages: false metadata: false
--- ---
{% include taglogic.html %} {% include taglogic.html %}

View File

@ -2,6 +2,6 @@
title: "Publishing Pages" title: "Publishing Pages"
permalink: /tag-publishing/ permalink: /tag-publishing/
tagName: publishing tagName: publishing
related_pages: false metadata: false
--- ---
{% include taglogic.html %} {% include taglogic.html %}

View File

@ -1,6 +1,6 @@
--- ---
title: "Single-Sourcing Pages" title: "Single-Sourcing Pages"
permalink: /tag-single-sourcing/ permalink: /tag-single-sourcing/
tagName: single-sourcing metadata: false
--- ---
{% include taglogic.html %} {% include taglogic.html %}

View File

@ -1,6 +1,6 @@
--- ---
title: "Special Layout Pages" title: "Special Layout Pages"
permalink: /tag-special-layouts/ permalink: /tag-special-layouts/
tagName: special-layouts metadata: false
--- ---
{% include taglogic.html %} {% include taglogic.html %}

View File

@ -1,8 +1,8 @@
--- ---
layout: none layout: none
search: exclude search: false
--- ---
{% include conditions.html %} {% include custom/conditions.html %}
{% for entry in sidebar %} {% for entry in sidebar %}
{% for subcategory in entry.subcategories %} {% for subcategory in entry.subcategories %}

View File

@ -1,17 +1,20 @@
--- ---
layout: none layout: none
search: false
--- ---
[ [
{% for page in site.pages %} {% for page in site.pages %}
{% if page.search == "include" %} {% if page.search == true %}
{ {
"title" : "{{ page.title | escape }}", "title": "{{ page.title | escape }}",
"category" : "{{ page.category }}", "tags": "{{ page.tags }}",
"url" : "{{ site.baseurl }}{{ page.url }}", "keywords": "{{page.keywords}}",
"date" : "{{ page.date }}", "url": "{{ site.baseurl }}{{ page.url }}",
"body": "{{ page.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}", "last_updated": "{{ page.last_updated }}",
"excerpt": "{{ page.content | strip_html | strip_newlines | truncate: 140, '…' | replace: '\', '\\' | replace: '"', '\\"' }}" "summary": "{{page.summary}}",
} {% unless forloop.last %},{% endunless %} "body": "{{ page.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}"
}
{% unless forloop.last %},{% endunless %}
{% endif %} {% endif %}
{% endfor %} {% endfor %}
@ -19,16 +22,16 @@ layout: none
{% for post in site.posts %} {% for post in site.posts %}
{% if forloop.length != 0 and forloop.first %},{% endif %} {% if forloop.length != 0 and forloop.first %},{% endif %}
{% if post.search == "include" %} {% if post.search == true %}
{ {
"title" : "{{ post.title | escape }}", "title": "{{ page.title | escape }}",
"category" : "{{ post.category }}", "tags": "{{ page.tags }}",
"tags" : "{{ post.tags | array_to_sentence_string }}", "keywords": "{{page.keywords}}",
"url" : "{{ site.baseurl }}{{ post.url }}", "url": "{{ site.baseurl }}{{ page.url }}",
"date" : "{{ post.date }}", "last_updated": "{{ page.last_updated }}",
"body": "{{ post.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}", "summary": "{{page.summary}}",
"excerpt": "{{ post.content | strip_html | strip_newlines | truncate: 140, '…' | replace: '\', '\\' | replace: '"', '\\"' }}" "body": "{{ page.content | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}"
} {% unless forloop.last %},{% endunless %} } {% unless forloop.last %},{% endunless %}
{% endif %} {% endif %}
{% endfor %} {% endfor %}
] ]

View File

@ -2,7 +2,7 @@
title: Tag Index title: Tag Index
excerpt: "An archive of posts sorted by tag." excerpt: "An archive of posts sorted by tag."
permalink: /tagindex/ permalink: /tagindex/
search: exclude search: false
related_pages: none related_pages: none
--- ---

View File

@ -1,20 +1,22 @@
--- ---
permalink: /titlepage/ permalink: /titlepage/
search: false
--- ---
{% comment %} this print-frontmatter class lets Prince apply a different header/footer for this page. {% endcomment %} {% comment %} this print-frontmatter class lets Prince apply a different header/footer for this page. {% endcomment %}
<div class="print-frontmatter"> <div class="print-frontmatter">
<div class="titleImage"> <div class="titleImage">
<img src="{{ "/images/jekyll.png" | prepend: site.baseurl }}" style="max-width: 600px;" > <img src="{{ "/images/adtruth_logo_big.png" | prepend: site.baseurl }}" style="max-width: 600px;" >
</div> </div>
<div class="guideTitleArea"> <div class="guideTitleArea">
<div class="guideTitle">{{site.print_title}}</div> <div class="guideTitle">{{site.print_title}}</div>
<div class="titleVersion">version {{site.version}}</div> <div class="titleVersion">version {{site.version}}</div>
<div class="titleVersion">Last generated: {{ site.time | date: "%b %-d, %Y" }} </div>
</div> </div>
<div id="navig"> <div id="navig">
<h1>Table of Contents</h1> <h1>Table of Contents</h1>
{% include conditions.html %} {% include custom/conditions.html %}
<ul id="mysidebar" class="nav"> <ul id="mysidebar" class="nav">
{% comment %} if you want a fixed floating sidebar, change the class to "nav affix" {% endcomment %} {% comment %} if you want a fixed floating sidebar, change the class to "nav affix" {% endcomment %}
@ -25,14 +27,14 @@ permalink: /titlepage/
<li class="sectionHead">{{ subcategory.title }} <li class="sectionHead">{{ subcategory.title }}
<ul> <ul>
{% for item in subcategory.items %} {% for item in subcategory.items %}
{% if item.audience contains buildAudience and item.print == true %} {% if item.audience contains buildAudience and item.print == true and item.toc != false %}
<li><a href="{{item.url | prepend: site.baseurl}}index.html">{{item.title}}</a> <li><a href="{{item.url | prepend: site.baseurl}}index.html">{{item.title}}</a>
{% for thirdlevel in item.thirdlevel %} {% for thirdlevel in item.thirdlevel %}
{% if thirdlevel.audience contains buildAudience and thirdlevel.print == true %} {% if thirdlevel.audience contains buildAudience and thirdlevel.print == true %}
<li class="sectionHead">{{ thirdlevel.title }} <li class="sectionHead">{{ thirdlevel.title }}
<ul> <ul>
{% for deeplevel in thirdlevel.thirdlevelitems%} {% for deeplevel in thirdlevel.thirdlevelitems%}
{% if deeplevel.audience contains buildAudience and deeplevel.print == true %} {% if deeplevel.audience contains buildAudience and deeplevel.print == true and item.toc != false %}
<li><a href="{{deeplevel.url | prepend: site.baseurl}}index.html">{{deeplevel.title}}</a></li> <li><a href="{{deeplevel.url | prepend: site.baseurl}}index.html">{{deeplevel.title}}</a></li>
{% endif %} {% endif %}
{% endfor %} {% endfor %}

View File

@ -1,6 +1,6 @@
--- ---
layout: none layout: none
search: exclude search: false
--- ---
{ {
"entries": "entries":