Revert "cleanup and new navigation ideas"
This commit is contained in:
Tom Johnson
GitHub
parent
e48d3757be
commit
6653e1a846
1
Gemfile
1
Gemfile
@ -1,4 +1,5 @@
|
||||
source "https://rubygems.org"
|
||||
|
||||
# gem "rails"
|
||||
gem 'github-pages'
|
||||
gem 'jekyll'
|
||||
43
_config.yml
43
_config.yml
@ -49,18 +49,6 @@ kramdown:
|
||||
collections:
|
||||
tooltips:
|
||||
output: false
|
||||
my_docs:
|
||||
title: Jekyll Doc Theme
|
||||
version: 5.0
|
||||
output: true
|
||||
product1:
|
||||
title: Product1
|
||||
version: 1.0
|
||||
output: true
|
||||
product2:
|
||||
title: Product2
|
||||
version: 1.0
|
||||
output: true
|
||||
# collection declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output.
|
||||
|
||||
defaults:
|
||||
@ -82,36 +70,6 @@ defaults:
|
||||
comments: true
|
||||
search: true
|
||||
tooltip: true
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
type: "my_docs"
|
||||
values:
|
||||
layout: "page"
|
||||
comments: true
|
||||
search: true
|
||||
tooltip: true
|
||||
collection: "my_docs"
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
type: "product1"
|
||||
values:
|
||||
layout: "page"
|
||||
comments: true
|
||||
search: true
|
||||
tooltip: true
|
||||
collection: "product1"
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
type: "product2"
|
||||
values:
|
||||
layout: "page"
|
||||
comments: true
|
||||
search: true
|
||||
tooltip: true
|
||||
collection: "product2"
|
||||
|
||||
-
|
||||
scope:
|
||||
@ -128,3 +86,4 @@ defaults:
|
||||
|
||||
description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
|
||||
# the description is used in the feed.xml file
|
||||
|
||||
|
||||
27
_data/sidebars/home_sidebar.yml
Normal file
27
_data/sidebars/home_sidebar.yml
Normal file
@ -0,0 +1,27 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: Sidebar
|
||||
levels: one
|
||||
folders:
|
||||
|
||||
- title: Products
|
||||
output: web
|
||||
folderitems:
|
||||
- title: Home
|
||||
url: /
|
||||
output: web
|
||||
type: homepage
|
||||
- title: News
|
||||
url: /news/
|
||||
output: web
|
||||
- title: Theme instructions
|
||||
url: /mydoc_introduction/
|
||||
output: web
|
||||
- title: Product 1
|
||||
url: /p1_landing_page/
|
||||
output: web
|
||||
- title: Product 2
|
||||
url: /p2_landing_page/
|
||||
output: web
|
||||
|
||||
279
_data/sidebars/mydoc_sidebar.yml
Normal file
279
_data/sidebars/mydoc_sidebar.yml
Normal file
@ -0,0 +1,279 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: sidebar
|
||||
product: Jekyll Doc Theme
|
||||
version: 5.0
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage/
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage/
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Overview
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Get started
|
||||
url: /
|
||||
type: homepage
|
||||
output: web, pdf
|
||||
|
||||
- title: 5.0 Release notes
|
||||
url: /mydoc_release_notes_50/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample page
|
||||
url: /samplepage/
|
||||
output: web, pdf
|
||||
|
||||
- title: Introduction
|
||||
url: /mydoc_introduction/
|
||||
output: web, pdf
|
||||
|
||||
- title: Supported features
|
||||
url: /mydoc_supported_features/
|
||||
output: web, pdf
|
||||
|
||||
- title: About the theme author
|
||||
url: /mydoc_about/
|
||||
output: web, pdf
|
||||
|
||||
- title: Support
|
||||
url: /mydoc_support/
|
||||
output: web, pdf
|
||||
|
||||
- title: Installation
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: About Ruby, Gems, Bundler, etc.
|
||||
url: /mydoc_about_ruby_gems_etc/
|
||||
output: web, pdf
|
||||
|
||||
- title: Install Jekyll on Mac
|
||||
url: /mydoc_install_jekyll_on_mac/
|
||||
output: web, pdf
|
||||
|
||||
- title: Install Jekyll on Windows
|
||||
url: /mydoc_install_jekyll_on_windows/
|
||||
output: web, pdf
|
||||
|
||||
- title: Authoring
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Pages
|
||||
url: /mydoc_pages/
|
||||
output: web, pdf
|
||||
|
||||
- title: Posts
|
||||
url: /mydoc_posts/
|
||||
output: web, pdf
|
||||
|
||||
- title: WebStorm Text Editor
|
||||
url: /mydoc_webstorm_text_editor/
|
||||
output: web, pdf
|
||||
|
||||
- title: Conditional logic
|
||||
url: /mydoc_conditional_logic/
|
||||
output: web, pdf
|
||||
|
||||
- title: Content reuse
|
||||
url: /mydoc_content_reuse/
|
||||
output: web, pdf
|
||||
|
||||
- title: Collections
|
||||
url: /mydoc_collections/
|
||||
output: web, pdf
|
||||
|
||||
- title: Navigation
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Sidebar navigation
|
||||
url: /mydoc_sidebar_navigation/
|
||||
output: web, pdf
|
||||
|
||||
- title: YAML tutorial in the context of Jekyll
|
||||
url: /mydoc_yaml_tutorial/
|
||||
output: web, pdf
|
||||
|
||||
- title: Tags
|
||||
url: /mydoc_tags/
|
||||
output: web, pdf
|
||||
|
||||
- title: Series
|
||||
url: /mydoc_series/
|
||||
output: web, pdf
|
||||
|
||||
- title: Formatting
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Tooltips
|
||||
url: /mydoc_adding_tooltips/
|
||||
output: web, pdf
|
||||
|
||||
- title: Alerts
|
||||
url: /mydoc_alerts/
|
||||
output: web, pdf
|
||||
|
||||
- title: Icons
|
||||
url: /mydoc_icons/
|
||||
output: web, pdf
|
||||
|
||||
- title: Images
|
||||
url: /mydoc_images/
|
||||
output: web, pdf
|
||||
|
||||
- title: Labels
|
||||
url: /mydoc_labels/
|
||||
output: web, pdf
|
||||
|
||||
- title: Links
|
||||
url: /mydoc_hyperlinks/
|
||||
output: web, pdf
|
||||
|
||||
- title: Navtabs
|
||||
url: /mydoc_navtabs/
|
||||
output: web, pdf
|
||||
|
||||
- title: Tables
|
||||
url: /mydoc_tables/
|
||||
output: web, pdf
|
||||
|
||||
- title: Syntax highlighting
|
||||
url: /mydoc_syntax_highlighting/
|
||||
output: web, pdf
|
||||
|
||||
- title: Handling reviews
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Commenting on files
|
||||
url: /mydoc_commenting_on_files/
|
||||
output: web, pdf
|
||||
|
||||
# - title: Git collaboration
|
||||
# url: /mydoc_git_collaboration/
|
||||
# output: web, pdf
|
||||
|
||||
- title: Publishing
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Build arguments
|
||||
url: /mydoc_build_arguments/
|
||||
output: web, pdf
|
||||
|
||||
- title: Themes
|
||||
url: /mydoc_themes/
|
||||
output: web, pdf
|
||||
|
||||
- title: Check page title consistency
|
||||
url: /mydoc_title_checker/
|
||||
output: web, pdf
|
||||
|
||||
- title: Generating PDFs
|
||||
url: /mydoc_generating_pdfs/
|
||||
output: web, pdf
|
||||
|
||||
- title: Help APIs and UI tooltips
|
||||
url: /mydoc_help_api/
|
||||
output: web, pdf
|
||||
|
||||
- title: Search configuration
|
||||
url: /mydoc_search_configuration/
|
||||
output: web, pdf
|
||||
|
||||
- title: iTerm profiles
|
||||
url: /mydoc_iterm_profiles/
|
||||
output: web, pdf
|
||||
|
||||
- title: Pushing builds to server
|
||||
url: /mydoc_push_build_to_server/
|
||||
output: web, pdf
|
||||
|
||||
- title: Getting around the password prompts in SCP
|
||||
url: /mydoc_no_password_prompts_scp/
|
||||
output: web, pdf
|
||||
|
||||
- title: Publishing on Github Pages
|
||||
url: /mydoc_publishing_github_pages/
|
||||
output: web, pdf
|
||||
|
||||
- title: Special layouts
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Knowledge-base layout
|
||||
url: /mydoc_kb_layout/
|
||||
output: web, pdf
|
||||
|
||||
- title: Glossary layout
|
||||
url: /mydoc_glossary/
|
||||
output: web, pdf
|
||||
|
||||
- title: FAQ layout
|
||||
url: /mydoc_faq_layout/
|
||||
output: web, pdf
|
||||
|
||||
- title: Troubleshooting
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
|
||||
- title: Troubleshooting
|
||||
url: /mydoc_troubleshooting/
|
||||
output: web, pdf
|
||||
|
||||
- title: Tag archives
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Tag archives overview
|
||||
url: /mydoc_tag_archives_overview/
|
||||
output: web
|
||||
|
||||
subfolders:
|
||||
- title: Tag archive pages
|
||||
output: web
|
||||
subfolderitems:
|
||||
|
||||
- title: Formatting pages
|
||||
url: /tag_formatting/
|
||||
output: web
|
||||
|
||||
- title: Navigation pages
|
||||
url: /tag_navigation/
|
||||
output: web
|
||||
|
||||
- title: Content types pages
|
||||
url: /tag_content_types/
|
||||
output: web
|
||||
|
||||
- title: Publishing pages
|
||||
url: /tag_publishing/
|
||||
output: web
|
||||
|
||||
- title: Special layout pages
|
||||
url: /tag_special_layouts/
|
||||
output: web
|
||||
|
||||
- title: Collaboration pages
|
||||
url: /tag_collaboration/
|
||||
output: web
|
||||
|
||||
- title: Troubleshooting pages
|
||||
url: /tag_troubleshooting/
|
||||
output: web
|
||||
60
_data/sidebars/product1_sidebar.yml
Normal file
60
_data/sidebars/product1_sidebar.yml
Normal file
@ -0,0 +1,60 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
|
||||
entries:
|
||||
- title: Sidebar
|
||||
product: Product1
|
||||
version: 1.0
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage/
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage/
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Getting Started
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
- title: Product 1 home
|
||||
url: /p1_landing_page/
|
||||
output: web
|
||||
|
||||
- title: Sample 1
|
||||
url: /p1_sample1/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 2
|
||||
url: /p1_sample2/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 3
|
||||
url: /p1_sample3/
|
||||
output: web, pdf
|
||||
|
||||
- title: Another heading
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Sample 4
|
||||
url: /p1_sample4/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 5
|
||||
url: /p1_sample5/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 6
|
||||
url: /p1_sample6/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 7
|
||||
url: /p1_sample7/
|
||||
output: web, pdf
|
||||
93
_data/sidebars/product2_sidebar.yml
Normal file
93
_data/sidebars/product2_sidebar.yml
Normal file
@ -0,0 +1,93 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: Product2
|
||||
product: Product2
|
||||
version: 1.0
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage/
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage/
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Introduction
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /p2_landing_page/
|
||||
output: web
|
||||
|
||||
- title: Simple Workflow
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Sample 1
|
||||
url: /p2_sample1/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 2
|
||||
url: /p2_sample2/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 3
|
||||
url: /p2_sample3/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 4
|
||||
url: /p2_sample4/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 5
|
||||
url: /p2_sample5/
|
||||
output: web, pdf
|
||||
|
||||
- title: Complex Workflow
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Sample 6
|
||||
url: /p2_sample6/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 7
|
||||
url: /p2_sample7/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 8
|
||||
url: /p2_sample8/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 9
|
||||
url: /p2_sample9/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 10
|
||||
url: /p2_sample10/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 11
|
||||
url: /p2_sample11/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 12
|
||||
url: /p2_sample12/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 13
|
||||
url: /p2_sample13/
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 14
|
||||
url: /p2_sample14/
|
||||
output: web, pdf
|
||||
54
_data/sidebars/tags_sidebar.yml
Normal file
54
_data/sidebars/tags_sidebar.yml
Normal file
@ -0,0 +1,54 @@
|
||||
|
||||
entries:
|
||||
- title: Tags Sidebar
|
||||
product: Tags
|
||||
version: all products
|
||||
levels: one
|
||||
output: web
|
||||
folders:
|
||||
|
||||
- title: News
|
||||
output: web
|
||||
folderitems:
|
||||
- title: News
|
||||
url: /news/
|
||||
output: web
|
||||
- title: News archive
|
||||
url: /news_archive/
|
||||
output: web
|
||||
- title: Tags
|
||||
output: web
|
||||
folderitems:
|
||||
- title: Collaboration
|
||||
url: /tag_collaboration/
|
||||
output: web
|
||||
- title: Content Types
|
||||
url: /tag_content_types/
|
||||
output: web
|
||||
- title: Formatting
|
||||
url: /tag_formatting/
|
||||
output: web
|
||||
- title: Getting started
|
||||
url: /tag_getting_started/
|
||||
output: web
|
||||
- title: Mobile
|
||||
url: /tag_mobile/
|
||||
output: web
|
||||
- title: Navigation
|
||||
url: /tag_navigation/
|
||||
output: web
|
||||
- title: News
|
||||
url: /tag_news/
|
||||
output: web
|
||||
- title: Publishing
|
||||
url: /tag_publishing/
|
||||
output: web
|
||||
- title: Single sourcing
|
||||
url: /tag_single_sourcing/
|
||||
output: web
|
||||
- title: Special layouts
|
||||
url: /tag_special_layouts/
|
||||
output: web
|
||||
- title: Troubleshooting
|
||||
url: /tag_troubleshooting/
|
||||
output: web
|
||||
@ -1,18 +0,0 @@
|
||||
my_docs:
|
||||
- Overview
|
||||
- Installation
|
||||
- Authoring
|
||||
- Navigation
|
||||
- Formatting
|
||||
- Handling reviews
|
||||
- Publishing
|
||||
- Special layouts
|
||||
- Troubleshooting
|
||||
- Tag archives
|
||||
product1:
|
||||
- Getting Started
|
||||
- Another heading
|
||||
product2:
|
||||
- Introduction
|
||||
- Simple Workflow
|
||||
- Complex Workflow
|
||||
@ -1,9 +1,17 @@
|
||||
## Topnav single links
|
||||
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
|
||||
topnav:
|
||||
- title: Topnav
|
||||
items:
|
||||
- title: News
|
||||
url: /news/
|
||||
|
||||
#Topnav dropdowns
|
||||
topnav_dropdowns:
|
||||
- title: Topnav dropdowns
|
||||
folders:
|
||||
- title: Jekyll Resources
|
||||
sub_items:
|
||||
folderitems:
|
||||
- title: Github Repo
|
||||
external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll
|
||||
- title: Jekyll Talk
|
||||
@ -15,10 +23,13 @@
|
||||
- title: Jekyll on my blog
|
||||
external_url: http://idratherbewriting.com/category-jekyll/
|
||||
- title: Products
|
||||
sub_items:
|
||||
folderitems:
|
||||
- title: Jekyll Documentation Theme
|
||||
url: /mydoc_introduction/
|
||||
- title: Product 1
|
||||
url: /p1_landing_page/
|
||||
- title: Product 2
|
||||
url: /p2_landing_page/
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,17 +1,23 @@
|
||||
{% case page.sidebar %}
|
||||
{% when "home_sidebar" %}
|
||||
{% if page.sidebar == "home_sidebar" %}
|
||||
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
|
||||
{% when "product1_sidebar" %}
|
||||
|
||||
{% elsif page.sidebar == "product1_sidebar" %}
|
||||
{% assign sidebar = site.data.sidebars.product1_sidebar.entries %}
|
||||
{% when "product2_sidebar" %}
|
||||
|
||||
{% elsif page.sidebar == "product2_sidebar" %}
|
||||
{% assign sidebar = site.data.sidebars.product2_sidebar.entries %}
|
||||
{% when "mydoc_sidebar" %}
|
||||
|
||||
{% elsif page.sidebar == "mydoc_sidebar" %}
|
||||
{% assign sidebar = site.data.sidebars.mydoc_sidebar.entries %}
|
||||
{% when "tags_sidebar" %}
|
||||
|
||||
{% elsif page.sidebar == "tags_sidebar" %}
|
||||
{% assign sidebar = site.data.sidebars.tags_sidebar.entries %}
|
||||
|
||||
{% else %}
|
||||
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
|
||||
{% endcase %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
|
||||
{% comment %}
|
||||
sidebar configuration for print files
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
{% if site.disqus_shortname %}
|
||||
|
||||
<div id="disqus_thread"></div>
|
||||
<script type="text/javascript">
|
||||
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
|
||||
|
||||
@ -1,16 +1,9 @@
|
||||
<footer>
|
||||
<div class="row">
|
||||
<div class="col-lg-12 footer">
|
||||
<p>
|
||||
©{{ site.time | date: "%Y" }} {{site.company_name}}. All rights reserved. <br />
|
||||
{% if page.last_updated %}
|
||||
Page last updated: {{ page.last_updated }}<br/>
|
||||
{% endif %}
|
||||
Site last generated: {{ site.time | date: "%b %-d, %Y" }}
|
||||
</p>
|
||||
<p>
|
||||
<img src="{{ "/images/company_logo.png" | prepend: site.baseurl }}" alt="Company logo"/>
|
||||
</p>
|
||||
{% if page.last_updated %}<p>Page last updated:</span> {{page.last_updated}}<br/>{% endif %} Site last generated: {{ site.time | date: "%b %-d, %Y" }} <br />
|
||||
<p><img src="{{ "/images/company_logo.png" | prepend: site.baseurl }}" alt="Company logo"/></p>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
@ -1,5 +1,6 @@
|
||||
<!-- the google_analytics_id gets auto inserted from the config file -->
|
||||
|
||||
{% if site.google_analytics %}
|
||||
|
||||
<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create','{{site.google_analytics}}','auto');ga('require','displayfeatures');ga('send','pageview');</script>
|
||||
{% endif %}
|
||||
@ -1,25 +1,14 @@
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
{% if page.summary %}
|
||||
<meta name="description" content="{{ page.summary | strip_html | strip_newlines | truncate: 160 }}">
|
||||
{% endif %}
|
||||
|
||||
<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
|
||||
<meta name="keywords" content="{{page.tags}}{% if page.tags %}, {% endif %} {{page.keywords}}">
|
||||
|
||||
<title>
|
||||
{% if page.homepage %}
|
||||
{{ site.homepage_title }}
|
||||
{% elsif page.title %}
|
||||
{{ page.title }}
|
||||
{% endif %}
|
||||
| {{ site.site_title }}
|
||||
</title>
|
||||
|
||||
<title>{% if page.homepage == true %} {{site.homepage_title}} {% elsif page.title %}{{ page.title }}{% endif %} | {{ site.site_title }}</title>
|
||||
<link rel="stylesheet" href="{{ "/css/syntax.css" | prepend: site.baseurl }}">
|
||||
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
|
||||
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
|
||||
<link rel="stylesheet" href="{{ "/css/modern-business.css" | prepend: site.baseurl }}">
|
||||
<link rel="stylesheet" href="{{ "/css/lavish-bootstrap.css" | prepend: site.baseurl }}">
|
||||
<link rel="stylesheet" href="{{ "/css/customstyles.css" | prepend: site.baseurl }}">
|
||||
@ -45,3 +34,8 @@
|
||||
<![endif]-->
|
||||
|
||||
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -27,3 +27,7 @@
|
||||
return "{{site.print_title}} User Guide";
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1 +1 @@
|
||||
<figure>{% if include.url %}<a class="no_icon" target="_blank" href="{{ include.url }}">{% endif %}<img class="docimage" src="{{ site.baseurl | prepend: site.url }}/images/{{ include.file }}" alt="{{ include.alt }}" {% if include.max-width %}style="max-width: {{ include.max-width }}px"{% endif %} />{% if include.url %}</a>{% endif %}{% if include.caption %}<figcaption>{{ include.caption }}</figcaption></figure>{% endif %}
|
||||
<figure>{% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}<img class="docimage" src="{{site.baseurl | prepend: site.url}}/images/{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />{% if {{include.url}} %}</a>{% endif %}{% if {{include.caption}} %}<figcaption>{{include.caption}}</figcaption></figure>{% endif %}
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
{% if include.link.external_url %}
|
||||
<li>
|
||||
<a href="{{ include.link.external_url }}" target="_blank">
|
||||
{{ include.link.title }}
|
||||
</a>
|
||||
</li>
|
||||
{% elsif include.link.url %}
|
||||
<li {% if page.url contains include.link.url %}class="active"{% endif %}>
|
||||
<a href="{{ include.link.url | prepend: site.baseurl }}">
|
||||
{{ include.link.title }}
|
||||
</a>
|
||||
</li>
|
||||
{% elsif include.link.sub_items %}
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||||
{{ include.link.title }}<b class="caret"></b>
|
||||
</a>
|
||||
<ul class="dropdown-menu">
|
||||
{% for entry in include.link.sub_items %}
|
||||
{% include nav_link.html link=entry %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endif %}
|
||||
@ -1,32 +1,48 @@
|
||||
{% assign product = site.collections | where: "label", include.collection | first %}
|
||||
{% include custom/sidebarconfigs.html %}
|
||||
|
||||
<div class="col-md-3"> <!-- Sidebar Column -->
|
||||
<ul id="mysidebar" class="nav">
|
||||
<li class="sidebarTitle">
|
||||
{{ product.title }} {{ product.version }}
|
||||
</li>
|
||||
|
||||
{% for category in site.data.sub_navigation[product.label] %}
|
||||
{% assign items = product.docs | where: "category", category %}
|
||||
{% assign items = items | sort: 'weight' %}
|
||||
{% assign number_of_items = items | size %}
|
||||
{% if number_of_items > 0 %}
|
||||
<li class="sidebarTitle">{{sidebar[0].product}} {{sidebar[0].version}}</li>
|
||||
{% for entry in sidebar %}
|
||||
{% for folder in entry.folders %}
|
||||
{% if folder.output contains "web" %}
|
||||
<li>
|
||||
<a href="#">
|
||||
{{ category }}
|
||||
</a>
|
||||
<a href="#">{{ folder.title }}</a>
|
||||
<ul>
|
||||
{% for item in items %}
|
||||
<li {% if page.url == item.url %}class="active"{% endif %}>
|
||||
<a href="{{ item.url | prepend: site.baseurl }}">
|
||||
{{ item.title }}
|
||||
</a>
|
||||
</li>
|
||||
{% for folderitem in folder.folderitems %}
|
||||
{% if folderitem.output contains "web" %}
|
||||
{% if folderitem.external_url %}
|
||||
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>
|
||||
{% elsif page.url == folderitem.url %}
|
||||
<li class="active"><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
|
||||
{% else %}
|
||||
<li><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
|
||||
{% endif %}
|
||||
{% for subfolders in folderitem.subfolders %}
|
||||
{% if subfolders.output contains "web" %}
|
||||
<li class="subfolders">
|
||||
<a href="#">{{ subfolders.title }}</a>
|
||||
<ul>
|
||||
{% for subfolderitem in subfolders.subfolderitems %}
|
||||
{% if subfolderitem.output contains "web" %}
|
||||
{% if subfolderitem.external_url %}
|
||||
<li><a href="{{subfolderitem.external_url}}" target="_blank">{{subfolderitem.title}}</a></li>
|
||||
{% elsif page.url == subfolderitem.url %}
|
||||
<li class="active"><a href="{{subfolderitem.url | prepend: site.baseurl}}">{{subfolderitem.title}}</a></li>
|
||||
{% else %}
|
||||
<li><a href="{{subfolderitem.url | prepend: site.baseurl}}">{{subfolderitem.title}}</a></li>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
<!-- if you aren't using the accordion, uncomment this block:
|
||||
<p class="external">
|
||||
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
|
||||
|
||||
@ -8,20 +8,45 @@
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
<a class="fa fa-home fa-lg navbar-brand" href="{{ site.baseurl }}/">
|
||||
<span class="projectTitle">{{ site.topnav_title }}</span>
|
||||
</a>
|
||||
<a class="fa fa-home fa-lg navbar-brand" href="{{site.baseurl}}/"> <span class="projectTitle"> {{site.topnav_title}}</span></a>
|
||||
</div>
|
||||
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
||||
<ul class="nav navbar-nav navbar-right">
|
||||
<!-- entries without drop-downs appear here -->
|
||||
{% for entry in site.data.topnav %}
|
||||
{% include nav_link.html link=entry %}
|
||||
{% for entry in site.data.topnav.topnav %}
|
||||
{% for item in entry.items %}
|
||||
{% if item.external_url %}
|
||||
<li><a href="{{item.external_url}}" target="_blank">{{item.title}}</a></li>
|
||||
{% elsif page.url contains item.url %}
|
||||
<li class="active"><a href="{{item.url | prepend: site.baseurl}}">{{item.title}}</a></li>
|
||||
{% else %}
|
||||
<li><a href="{{item.url | prepend: site.baseurl }}">{{item.title}}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
{% unless site.feedback_disable == true %}
|
||||
{% endfor %}
|
||||
<!-- entries with drop-downs appear here -->
|
||||
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
|
||||
{% for entry in site.data.topnav.topnav_dropdowns %}
|
||||
{% for folder in entry.folders %}
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ folder.title }}<b class="caret"></b></a>
|
||||
<ul class="dropdown-menu">
|
||||
{% for folderitem in folder.folderitems %}
|
||||
{% if folderitem.external_url %}
|
||||
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>
|
||||
{% elsif page.url contains folderitem.url %}
|
||||
<li class="dropdownActive"><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
|
||||
{% else %}
|
||||
<li><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% if site.feedback_disable == null or site.feedback_disable == false %}
|
||||
{% include feedback.html %}
|
||||
{% endunless %}
|
||||
{% endif %}
|
||||
<!--comment out this block if you want to hide search-->
|
||||
<li>
|
||||
<!--start search-->
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
{% include head.html %}
|
||||
<script>
|
||||
@ -30,17 +29,21 @@
|
||||
e.preventDefault();
|
||||
$("#mysidebar").navgoco('toggle', true);
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
</script>
|
||||
<script>
|
||||
$(function () {
|
||||
$('[data-toggle="tooltip"]').tooltip()
|
||||
})
|
||||
</script>
|
||||
{% if page.datatable %}
|
||||
{% 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>
|
||||
<script>
|
||||
$(document).ready(function(){
|
||||
|
||||
$('table.datatable').DataTable( {
|
||||
paging: false,
|
||||
stateSave: true
|
||||
@ -48,26 +51,35 @@
|
||||
);
|
||||
</script>
|
||||
{% endif %}
|
||||
|
||||
</head>
|
||||
<body>
|
||||
{% include topnav.html %}
|
||||
<div class="container"> <!-- Page Content -->
|
||||
<div class="col-lg-12">
|
||||
|
||||
</div>
|
||||
<div class="row"> <!-- Content Row -->
|
||||
{% include sidebar.html collection=page.collection %}
|
||||
<div class="col-md-9"> <!-- Content Column -->
|
||||
<!-- Page Content -->
|
||||
<div class="container">
|
||||
<div class="col-lg-12"> </div>
|
||||
<!-- Content Row -->
|
||||
<div class="row">
|
||||
<!-- Sidebar Column -->
|
||||
<div class="col-md-3">
|
||||
|
||||
{% include sidebar.html %}
|
||||
<!-- Content Column -->
|
||||
<div class="col-md-9">
|
||||
{{content}}
|
||||
</div> <!-- /.row -->
|
||||
</div> <!-- /.container -->
|
||||
</div>
|
||||
<!-- /.row -->
|
||||
</div>
|
||||
<!-- /.container -->
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function ($) {
|
||||
$('.post-content').annotator()
|
||||
.annotator('setupPlugins', { tokenUrl: 'http://example.com/api/token' });
|
||||
.annotator('setupPlugins', {tokenUrl: 'http://example.com/api/token'})
|
||||
});
|
||||
</script>
|
||||
{% include google_analytics.html %}
|
||||
</body>
|
||||
{% if site.google_analytics %}
|
||||
{% include google_analytics.html %}
|
||||
{% endif %}
|
||||
</html>
|
||||
3
_layouts/none.html
Normal file
3
_layouts/none.html
Normal file
@ -0,0 +1,3 @@
|
||||
---
|
||||
---
|
||||
{{content}}
|
||||
@ -3,16 +3,11 @@ layout: default
|
||||
---
|
||||
|
||||
<div class="post-header">
|
||||
<h1 class="post-title-main">
|
||||
{% if page.homepage == true %}
|
||||
{{ site.homepage_title }}
|
||||
{% else %}
|
||||
{{ page.title }}
|
||||
{% endif %}
|
||||
</h1>
|
||||
<h1 class="post-title-main">{% if page.homepage == true %} {{site.homepage_title}} {% else %}{{ page.title }}{% endif %}</h1>
|
||||
</div>
|
||||
|
||||
{% if page.map == true %}
|
||||
|
||||
<script>
|
||||
$(document).ready ( function(){
|
||||
$('.box{{page.box_number}}').addClass('active');
|
||||
@ -35,16 +30,19 @@ layout: default
|
||||
{% endunless %}
|
||||
|
||||
{% unless jekyll.environment == "production" %}
|
||||
|
||||
{% if site.github_editme_path %}
|
||||
|
||||
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{% unless page.url contains "html" %}{{page.url | replace: '.html', '.md'}}{% endunless %}{% if page.url contains "html" %}{{page.url }}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||||
{% endif %}
|
||||
|
||||
{% endunless %}
|
||||
|
||||
{{content}}
|
||||
|
||||
<div class="tags">
|
||||
{% if page.tags != null %}
|
||||
<strong>Tags: </strong>
|
||||
<b>Tags: </b>
|
||||
{% assign projectTags = site.data.tags.allowed-tags %}
|
||||
{% for tag in page.tags %}
|
||||
{% if projectTags contains tag %}
|
||||
|
||||
@ -5,26 +5,31 @@ layout: default
|
||||
|
||||
<header class="post-header">
|
||||
<h1 class="post-title" itemprop="name headline">{{ page.title }}</h1>
|
||||
<p class="post-meta">
|
||||
<time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">{{ page.date | date: "%b %-d, %Y" }}</time>{% if page.author %}<span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">/ {{ page.author }}</span></span>{% endif %}
|
||||
{% if page.tags != null %}/
|
||||
<p class="post-meta"><time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">{{ page.date | date: "%b %-d, %Y" }}</time> {% if page.author %}<span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">/ {{ page.author }}</span></span>{% endif %}{% if page.tags != null %}/
|
||||
{% assign projectTags = site.data.tags.allowed-tags %}
|
||||
{% for tag in page.tags %}
|
||||
{% if projectTags contains tag %}
|
||||
<a href="{{ "/tag_" | prepend: site.baseurl | append: tag }}">{{ tag }}</a>
|
||||
{% unless forloop.last %}, {% endunless%}
|
||||
<a href="{{ "/tag_" | prepend: site.baseurl | append: tag }}">{{tag}}</a>{% unless forloop.last %}, {% endunless%}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<div class="post-content" itemprop="articleBody">
|
||||
|
||||
{% if page.summary %}
|
||||
<div class="summary">{{page.summary}}</div>
|
||||
{% endif %}
|
||||
|
||||
{{ content }}
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
{% if site.disqus %}
|
||||
@ -34,3 +39,7 @@ layout: default
|
||||
{{site.data.alerts.hr_shaded}}
|
||||
|
||||
{% include footer.html %}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,11 +1,8 @@
|
||||
---
|
||||
title: "Test post from last year"
|
||||
categories:
|
||||
- jekyll
|
||||
- update
|
||||
categories: jekyll update
|
||||
permalink: /test-post-from-last-year/
|
||||
tags:
|
||||
- news
|
||||
tags: [news]
|
||||
---
|
||||
|
||||
This is just a test post from the previous year.
|
||||
|
||||
@ -1,11 +1,8 @@
|
||||
---
|
||||
title: "Welcome to Jekyll!"
|
||||
categories:
|
||||
- jekyll
|
||||
- update
|
||||
categories: jekyll update
|
||||
permalink: /myupdate/
|
||||
tags:
|
||||
- news
|
||||
tags: [news]
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Sample post"
|
||||
published: true
|
||||
permalink: /samplepost/
|
||||
summary: "This is some summary frontmatter for my sample post."
|
||||
tags:
|
||||
- news, getting_started
|
||||
tags: [news, getting_started]
|
||||
---
|
||||
|
||||
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries
|
||||
@ -13,3 +13,4 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem
|
||||
but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
|
||||
|
||||
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries
|
||||
|
||||
|
||||
5
feed.xml
5
feed.xml
@ -1,6 +1,6 @@
|
||||
---
|
||||
search: exclude
|
||||
layout: null
|
||||
layout: none
|
||||
---
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
@ -20,6 +20,9 @@ layout: null
|
||||
<pubDate>{{ post.date | date_to_rfc822 }}</pubDate>
|
||||
<link>{{ post.url | prepend: site.baseurl | prepend: site.url }}</link>
|
||||
<guid isPermaLink="true">{{ post.url | prepend: site.baseurl | prepend: site.url }}</guid>
|
||||
{% for tag in post.tags %}
|
||||
<category>{{ tag | xml_escape }}</category>
|
||||
{% endfor %}
|
||||
{% for tag in page.tags %}
|
||||
<category>{{ cat | xml_escape }}</category>
|
||||
{% endfor %}
|
||||
|
||||
6
index.md
6
index.md
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Getting started overview
|
||||
tags:
|
||||
- getting_started
|
||||
tags: [getting_started]
|
||||
sidebar: mydoc_sidebar
|
||||
type: homepage
|
||||
---
|
||||
@ -266,3 +265,6 @@ If you want to use a simple system for managing links, see the "Managed Links" s
|
||||
## Other instructions
|
||||
|
||||
For other details in working with the theme, see the various sections in the sidebar.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2,13 +2,10 @@
|
||||
title: About the theme author
|
||||
keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements
|
||||
last_updated: March 20, 2016
|
||||
tags:
|
||||
- getting_started
|
||||
tags: [getting_started]
|
||||
summary: "I have used this theme for projects that I've worked on as a professional technical writer."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_about/
|
||||
category: Overview
|
||||
weight: 5
|
||||
---
|
||||
|
||||
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.
|
||||
@ -1,14 +1,10 @@
|
||||
---
|
||||
title: About Ruby, Gems, Bundler, and other prerequisites
|
||||
tags:
|
||||
- getting_started
|
||||
- troubleshooting
|
||||
tags: [getting_started, troubleshooting]
|
||||
keywords:
|
||||
summary: "Ruby is a programming language you must have on your computer in order to build Jekyll locally. Ruby has various gems (or plugins) that provide various functionality. Each Jekyll project usually requires certain gems."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_about_ruby_gems_etc/
|
||||
category: Installation
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## About Ruby
|
||||
@ -253,3 +249,4 @@ BUNDLED WITH
|
||||
You can always delete the Gemlock file and run Bundle install again to get the latest versions. You can also run `bundle update`, which will ignore the Gemlock file to get the latest versions of each gem.
|
||||
|
||||
To learn more about Bundler, see [Bundler's Purpose and Rationale](http://bundler.io/rationale.html).
|
||||
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Tooltips
|
||||
tags:
|
||||
- formatting
|
||||
tags: [formatting]
|
||||
keywords: popovers, tooltips, user interface text, glossaries, definitions
|
||||
last_updated: March 20, 2016
|
||||
summary: "You can add tooltips to any word, such as an acronym or specialized term. Tooltips work well for glossary definitions, because you don't have to keep repeating the definition, nor do you assume the reader already knows the word's meaning."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_adding_tooltips/
|
||||
category: Formatting
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Creating tooltips
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Alerts
|
||||
tags:
|
||||
- formatting
|
||||
tags: [formatting]
|
||||
keywords: notes, tips, cautions, warnings, admonitions
|
||||
last_updated: March 20, 2016
|
||||
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data references such as site.data.alerts.note."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_alerts/
|
||||
category: Formatting
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## About alerts
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Build arguments
|
||||
tags:
|
||||
- publishing
|
||||
tags: [publishing]
|
||||
keywords: building, serving, serve, build
|
||||
last_updated: March 20, 2016
|
||||
summary: "You use various build arguments with your Jekyll project. You can also create shell scripts to act as shortcuts for long build commands. You can store the commands in iTerm as profiles as well."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_build_arguments/
|
||||
category: Publishing
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## How to build Jekyll sites
|
||||
@ -66,3 +63,7 @@ kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}')
|
||||
I recommend creating a profile in iTerm that stores this command. Here's what the iTerm settings look like:
|
||||
|
||||
![iTerm profile settings to kill all Jekyll]({{ "/images/killalljekyll.png" | prepend: site.baseurl }})
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Collections
|
||||
tags:
|
||||
- content_types
|
||||
tags: [content_types]
|
||||
keywords: groups, api, structure
|
||||
last_updated: March 20, 2016
|
||||
summary: "Collections are useful if you want to loop through a special folder of pages that you make available in a content API. You could also use collections if you have a set of articles that you want to treat differently from the other content, with a different layout or format."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_collections/
|
||||
category: Authoring
|
||||
weight: 6
|
||||
---
|
||||
|
||||
## What are collections
|
||||
@ -7,8 +7,6 @@ last_updated: "November 30, 2016"
|
||||
summary: "You can add a button to your pages that allows people to add comments."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_commenting_on_files/
|
||||
category: Handling reviews
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## About the review process
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can implement advanced conditional logic that includes if statements, or statements, unless, and more. This conditional logic facilitates single sourcing scenarios in which you're outputting the same content for different audiences."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_conditional_logic/
|
||||
category: Authoring
|
||||
weight: 4
|
||||
---
|
||||
|
||||
## About Liquid and conditional statements
|
||||
@ -153,3 +151,4 @@ Then create a folder called \_data_beta.
|
||||
If you have a lot of conditions in your text, it can get confusing. As a best practice, whenever you insert an `if` condition, add the `endif` at the same time. This will reduce the chances of forgetting to close the if statement. Jekyll won't build if there are problems with the liquid logic.
|
||||
|
||||
If your text is getting busy with a lot of conditional statements, consider putting a lot of content into includes so that you can more easily see where the conditions begin and end.
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can reuse chunks of content by storing these files in the includes folder. You then choose to include the file where you need it. This works similar to conref in DITA, except that you can include the file in any content type."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_content_reuse/
|
||||
category: Authoring
|
||||
weight: 5
|
||||
---
|
||||
|
||||
## About content reuse
|
||||
@ -2,14 +2,11 @@
|
||||
title: FAQ layout
|
||||
permalink: /mydoc_faq_layout/
|
||||
sidebar: mydoc_sidebar
|
||||
tags:
|
||||
- special_layouts
|
||||
tags: [special_layouts]
|
||||
keywords: frequently asked questions, FAQ, question and answer, collapsible sections, expand, collapse
|
||||
last_updated: November 30, 2015
|
||||
summary: "You can use an accordion-layout that takes advantage of Bootstrap styling. This is useful for an FAQ page."
|
||||
toc: false
|
||||
category: Special layouts
|
||||
weight: 3
|
||||
---
|
||||
|
||||
<p>If you want to use an FAQ format, use the syntax shown on the faq.html page. Rather than including code samples here (which are bulky with a lot of nested <code>div</code> tags), just look at the source in the mydoc_faq.html theme file.</p>
|
||||
@ -134,3 +131,4 @@ weight: 3
|
||||
<!-- /.panel -->
|
||||
</div>
|
||||
<!-- /.panel-group -->
|
||||
|
||||
@ -1,16 +1,11 @@
|
||||
---
|
||||
title: Generating PDFs
|
||||
permalink: /mydoc_generating_pdfs/
|
||||
tags:
|
||||
- publishing
|
||||
- single_sourcing
|
||||
- content_types
|
||||
tags: [publishing, single_sourcing, content_types]
|
||||
keywords: PDF, prince, prince XML, ant, xsl fo
|
||||
last_updated: March 20, 2016
|
||||
summary: "You can generate a PDF from your Jekyll project. You do this by creating a web version of your project that is printer friendly. You then use utility called Prince to iterate through the pages and create a PDF from them. It works quite well and gives you complete control to customize the PDF output through CSS, including page directives and dynamic tags from Prince."
|
||||
sidebar: mydoc_sidebar
|
||||
category: Publishing
|
||||
weight: 4
|
||||
---
|
||||
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
---
|
||||
title: Git notes and tips
|
||||
summary: "If you're interacting with your team using Git, the notes and tips will help you collaborate efficiently."
|
||||
tags:
|
||||
- collaboration
|
||||
tags: collaboration
|
||||
keywords: git, github, collaboration, interaction, file sharing, push
|
||||
published: false
|
||||
sidebar: mydoc_sidebar
|
||||
@ -180,3 +179,4 @@ From the interface, you can also create a pull request to merge all of the chang
|
||||
| see what has changed since last commit | `git diff` |
|
||||
| commit changes | `git commit` |
|
||||
| | |
|
||||
|
||||
@ -1,16 +1,12 @@
|
||||
---
|
||||
title: Glossary layout
|
||||
tags:
|
||||
- formatting
|
||||
- special_layouts
|
||||
tags: [formatting, special_layouts]
|
||||
keywords: definitions, glossaries, terms, style guide
|
||||
last_updated: March 20, 2016
|
||||
summary: "Your glossary page can take advantage of definitions stored in a data file. This gives you the ability to reuse the same definition in multiple places. Additionally, you can use Bootstrap classes to arrange your definition list horizontally."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_glossary/
|
||||
toc: false
|
||||
category: Special layouts
|
||||
weight: 2
|
||||
---
|
||||
|
||||
|
||||
@ -6,8 +6,6 @@ keywords: API, content API, UI text, inline help, context-sensitive help, popove
|
||||
summary: "You can loop through files and generate a JSON file that developers can consume like a help API. Developers can pull in values from the JSON into interface elements, styling them as popovers for user interface text, for example. The beauty of this method is that the UI text remains in the help system (or at least in a single JSON file delivered to the dev team) and isn't hard-coded into the UI."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_help_api/
|
||||
category: Publishing
|
||||
weight: 5
|
||||
---
|
||||
|
||||
## Full code demo of content API
|
||||
@ -7,8 +7,6 @@ summary: "When creating links, you can use standard HTML or Markdown formatting.
|
||||
last_updated: March 20, 2016
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_hyperlinks/
|
||||
category: Formatting
|
||||
weight: 6
|
||||
---
|
||||
|
||||
## Create an external link
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Icons
|
||||
tags:
|
||||
- formatting
|
||||
tags: [formatting]
|
||||
keywords: font icons, buttons, images, vectors, font awesome, glyphicons
|
||||
last_updated: March 20, 2016
|
||||
summary: "You can integrate font icons through the Font Awesome and Glyphical Halflings libraries. These libraries allow you to embed icons through their libraries delivered as a link reference. You don't need any image libraries downloaded in your project."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_icons/
|
||||
category: Formatting
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## Font icon options
|
||||
@ -225,3 +222,4 @@ You can use any of the following:
|
||||
The only difference is the color of the left bar.
|
||||
|
||||
Callouts are explained in a bit more detail in <a href="{{ "/mydoc_alerts" | prepend: site.baseurl }}">Alerts</a>.
|
||||
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Images
|
||||
tags:
|
||||
- formatting
|
||||
tags: [formatting]
|
||||
keywords: images, screenshots, vectors, svg, markdown syntax
|
||||
last_updated: March 20, 2016
|
||||
summary: "Store images in the images folder and use the image.html include to insert images. This include has several options, including figcaptions, that extract the content from the formatting."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_images/
|
||||
category: Formatting
|
||||
weight: 4
|
||||
---
|
||||
|
||||
## Image Include Template
|
||||
@ -5,8 +5,6 @@ keywords:
|
||||
summary: "Installation of Jekyll on Mac is usually less problematic than on Windows. However, you may run into permissions issues with Ruby that you must overcome. You should also use Bundler to be sure that you have all the required gems and other utilities on your computer to make the project run. "
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_install_jekyll_on_mac/
|
||||
category: Installation
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## Ruby and RubyGems
|
||||
@ -3,8 +3,6 @@ title: Install Jekyll on Windows
|
||||
permalink: /mydoc_install_jekyll_on_windows/
|
||||
keywords: jekyll on windows, pc, ruby, ruby dev kit
|
||||
sidebar: mydoc_sidebar
|
||||
category: Installation
|
||||
weight: 3
|
||||
---
|
||||
|
||||
{{site.data.alerts.tip}} For a better terminal emulator on Windows, use [Git Bash](https://git-for-windows.github.io/). Git Bash gives you Linux-like control on Windows. {{site.data.alerts.end}}
|
||||
@ -2,7 +2,6 @@
|
||||
title: Introduction
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_introduction/
|
||||
category: Overview
|
||||
---
|
||||
|
||||
## Overview
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can set up profiles in iTerm to facilitate the build process with just a few clicks. This can make it a lot easier to quickly build multiple outputs."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_iterm_profiles/
|
||||
category: Publishing
|
||||
weight: 7
|
||||
---
|
||||
|
||||
## About iTerm profiles
|
||||
@ -7,8 +7,6 @@ summary: "This shows a sample layout for a knowledge base. Each square could lin
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_kb_layout/
|
||||
toc: false
|
||||
category: Special layouts
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Here's the sample knowledge-base style layout:
|
||||
@ -1,14 +1,11 @@
|
||||
---
|
||||
title: Labels
|
||||
tags:
|
||||
- formatting
|
||||
tags: [formatting]
|
||||
keywords: labels, buttons, bootstrap, api methods
|
||||
last_updated: March 20, 2016
|
||||
summary: "Labels are just a simple Bootstrap component that you can include in your pages as needed. They represent one of many Bootstrap options you can include in your theme."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_labels/
|
||||
category: Formatting
|
||||
weight: 5
|
||||
---
|
||||
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "Navtabs provide a tab-based navagation directly in your content, allowing users to click from tab to tab to see different panels of content. Navtabs are especially helpful for showing code samples for different programming languages. The only downside to using navtabs is that you must use HTML instead of Markdown."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_navtabs/
|
||||
category: Formatting
|
||||
weight: 7
|
||||
---
|
||||
|
||||
|
||||
@ -103,3 +101,4 @@ By setting a cookie, if the user refreshes the page, the active tab is the tab t
|
||||
## Functionality to implement
|
||||
|
||||
One piece of functionality I'd like to implement is the ability to set site-wide nav tab options. For example, if the user always chooses PHP instead of Java in the code samples, it would be great to set this option site-wide by default. However, this functionality isn't yet coded.
|
||||
|
||||
@ -4,8 +4,6 @@ sidebar: mydoc_sidebar
|
||||
tags: [publishing, troubleshooting]
|
||||
permalink: /mydoc_no_password_prompts_scp/
|
||||
summary: "You can publish your docs via SSH through a Terminal window or more likely, via a shell script that you simply execute as part of the publishing process. However, you will be prompted for your password with each file transfer unless you configure passwordless SSH. The basic process for setting up password less SSH is to create a key on your own machine that you also transfer to the remote machine. When you use the SCP command, the remote machine checks that you have the authorized key and allows access without a password prompt."
|
||||
category: Publishing
|
||||
weight: 9
|
||||
---
|
||||
|
||||
## Get rid of password prompts
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "This theme primarily uses pages. You need to make sure your pages have the appropriate frontmatter. One frontmatter tag your users might find helpful is the summary tag. This functions similar in purpose to the shortdesc element in DITA."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_pages/
|
||||
category: Authoring
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Where to author content
|
||||
@ -6,8 +6,6 @@ last_updated: Feb 25, 2016
|
||||
summary: "You can use posts when you want to create blogs or news type of content."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_posts/
|
||||
category: Authoring
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## About posts
|
||||
@ -41,3 +39,6 @@ tags: content_types
|
||||
| **keywords** | Optional | Synonyms and other keywords for the page. This information gets stuffed into the page's metadata to increase SEO. The user won't see the keywords, but if you search for one of the keywords, it will be picked up by the search engine. |
|
||||
| **summary** | Optional | A 1-2 word sentence summarizing the content on the page. This gets formatted into the summary section in the page layout. Adding summaries is a key way to make your content more scannable by users (check out [Jakob Nielsen's site](http://www.nngroup.com/articles/corporate-blogs-front-page-structure/) for a great example of page summaries.) The only drawback with summaries is that you can't use variables in them. |
|
||||
| **permalink**| Required | This theme uses permalinks to facilitate the linking. You specify the permalink want for the page, and the \_site output will put the page into the root directory when you publish. The page will appear inside a folder by the same name, with the actual page being index.html. Browsers will automatically show the index.html file inside of any folder, so permalinks avoid the .html extension with file names. Permalink names don't have to match your file names, but it might be easier to keep them in sync. |
|
||||
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@ title: Publishing on Github Pages
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_publishing_github_pages/
|
||||
summary: "You can publish your project on Github Pages, which is a free web hosting service provided by Github. All you need is to put your content into a Github repo branch called gh-pages and make this your default branch in your repo. With a Jekyll site, you just commit your entire project into the gh-pages branch and Github Pages will build the site for you."
|
||||
category: Publishing
|
||||
weight: 10
|
||||
---
|
||||
|
||||
## Set up your Github repo
|
||||
@ -71,3 +69,4 @@ Github Pages will now automatically build your site. Wait a minute or two, and t
|
||||
## Customize your URL
|
||||
|
||||
You can also customize your Github URL. More instructions on this later....
|
||||
|
||||
@ -6,9 +6,9 @@ last_updated: March 20, 2016
|
||||
summary: "You can push your build to AWS using commands from the command line. By including your copy commands in commands, you can package all of the build and deploy process into executable scripts."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_push_build_to_server/
|
||||
category: Publishing
|
||||
weight: 8
|
||||
---
|
||||
|
||||
|
||||
## Pushing to AWS S3
|
||||
|
||||
If you have the AWS Command Line Interface installed and are pushing your builds to AWS, the following commands show how you can build and push to an AWS location from the command line:
|
||||
@ -30,3 +30,5 @@ scp -r /users/tjohnson/projects/mydocproject/ name@domain:/var/www/html/mydocpro
|
||||
```
|
||||
|
||||
Similar to the above, the first path is the local location; the second path is the destination.
|
||||
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "Version 5.0 of the Documentation theme for Jekyll changes some fundamental ways the theme works to provide product-specific sidebars, intended to accommodate a site where multiple products are grouped together on the same site rather than generated out as separate outputs."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_release_notes_50/
|
||||
category: Overview
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## Unique sidebars for each product
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "The search feature uses JavaScript to look for keyword matches in a JSON file. The results show instant matches, but it doesn't provide a search results page like Google. Also, sometimes invalid formatting can break the JSON file."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_search_configuration/
|
||||
category: Publishing
|
||||
weight: 6
|
||||
---
|
||||
|
||||
## About search
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can automatically link together topics belonging to the same series. This helps users know the context within a particular process."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_series/
|
||||
category: Navigation
|
||||
weight: 4
|
||||
---
|
||||
|
||||
## Using series for pages
|
||||
@ -6,8 +6,6 @@ keywords: sidebar, accordion, yaml, iteration, for loop, navigation, attributes,
|
||||
summary: "The sidebar navigation uses a jQuery component called Navgoco. The sidebar is a somewhat complex part of the theme that remembers your current page, highlights the active item, stays in a fixed position on the page, and more. This page explains a bit about how the sidebar was put together."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_sidebar_navigation/
|
||||
category: Navigation
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Navgoco foundation
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "Contact me for any support issues."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_support/
|
||||
category: Overview
|
||||
weight: 7
|
||||
---
|
||||
|
||||
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).
|
||||
@ -8,8 +8,6 @@ summary: "If you're not sure whether Jekyll and this theme will support your req
|
||||
published: true
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_supported_features/
|
||||
category: Overview
|
||||
weight: 5
|
||||
---
|
||||
|
||||
Before you get into exploring Jekyll as a potential platform for help content, you may be wondering if it supports some basic features needed to fulfill your tech doc requirements. The following table shows what is supported in Jekyll and this theme.
|
||||
@ -51,3 +49,5 @@ Standardized templates | No | You can create pages with any structure you want.
|
||||
Integration with Swagger | No | You can link to a SwaggerUI output, but there is no built-in integration of SwaggerUI into this documentation theme.
|
||||
Templates for endpoints | No | Although static site generators work well with API documentation, there aren't any built-in templates specific to endpoints in this theme. You could construct your own, though.
|
||||
eBook output | No | There isn't an eBook output for the content.
|
||||
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_syntax_highlighting/
|
||||
category: Formatting
|
||||
weight: 9
|
||||
---
|
||||
|
||||
## About syntax highlighting
|
||||
@ -75,3 +73,4 @@ The keywords you must add to specify the highlighting (in the previous example,
|
||||
* dotnet
|
||||
* xml
|
||||
* http
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
title: Tables
|
||||
tags:
|
||||
- formatting
|
||||
tags: [formatting]
|
||||
keywords: datatables, tables, grids, markdown, multimarkdown, jquery plugins
|
||||
last_updated: March 20, 2016
|
||||
datatable: true
|
||||
summary: "You can format tables using either multimarkdown syntax or HTML. You can also use jQuery datatables (a plugin) if you need more robust tables."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_tables/
|
||||
category: Formatting
|
||||
weight: 8
|
||||
---
|
||||
|
||||
{% unless site.output == "pdf" %}
|
||||
<script>
|
||||
$(document).ready(function(){
|
||||
|
||||
$('table.display').DataTable( {
|
||||
paging: true,
|
||||
stateSave: true,
|
||||
searching: true
|
||||
});
|
||||
}
|
||||
);
|
||||
});
|
||||
</script>
|
||||
{% endunless %}
|
||||
@ -6,8 +6,6 @@ tags: [navigation]
|
||||
summary: "This is an overview to the tag archives section. Really the only reason this section is listed explicitly in the TOC here is to demonstrate how to add a third-level to the navigation."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_tag_archives_overview/
|
||||
category: Tag archives
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Reasons for tags
|
||||
@ -7,8 +7,6 @@ keywords: tags, navigation, buttons, links, association
|
||||
summary: "Tags provide another means of navigation for your content. Unlike the table of contents, tags can show the content in a variety of arrangements and groupings. Implementing tags in this Jekyll theme is somewhat of a manual process."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_tags/
|
||||
category: Navigation
|
||||
weight: 3
|
||||
---
|
||||
|
||||
|
||||
@ -185,3 +183,4 @@ If you don't want tags to appear at all on your page, remove the tags property f
|
||||
Since you may have many tags and find it difficult to remember what tags are allowed, I recommend creating a template that prepopulates all your frontmatter with all possible tags. Then just remove the tags that don't apply.
|
||||
|
||||
See <a href="{{ "/mydoc_webstorm_text_editor" | prepend: site.baseurl }}">WebStorm Text Editor</a> for tips on creating file templates in WebStorm.
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can choose between two different themes (one green, the other blue) for your projects. The theme CSS is stored in the CSS folder and configured in the configuration file for each project."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_themes/
|
||||
category: Publishing
|
||||
weight: 2
|
||||
---
|
||||
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: "November 30, 2016"
|
||||
summary: "The title checker page helps ensure that the titles in your pages match the titles in your TOC."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_title_checker/
|
||||
category: Publishing
|
||||
weight: 3
|
||||
---
|
||||
|
||||
The theme has a file called title-checker.html. This file will iterate through all the pages listed in the sidebar navigation and top navigation, and compare the navigation titles against the page titles based on matching URLs. If there are inconsistencies in the titles, they get noted on the title-checker.html page.
|
||||
@ -19,3 +17,4 @@ Note that in order for the title-checker file to run correctly, it has to detect
|
||||
{{site.data.alerts.note}} If your page titles have your product name in parentheses, but your sidebar doesn't have the product name in parentheses, this title-checker tool is going to return a lot of mismatches. This is one limitation of the code right now. {{site.data.alerts.end}}
|
||||
|
||||
Note also that you must manually configure your sidebar file in the first line of the code, and then repeat the same chunk of code for each sidebar. Right now the code doesn't automatically iterate over every sidebar file. It's somewhat of a manual configuration process there.
|
||||
|
||||
@ -6,8 +6,6 @@ last_updated: March 20, 2016
|
||||
summary: "This page lists common errors and the steps needed to troubleshoot them."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_troubleshooting/
|
||||
category: Troubleshooting
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Issues building the site
|
||||
@ -74,3 +72,7 @@ If the sidebar levels aren't collapsed, usually your JavaScript is broken somewh
|
||||
### Search isn't working
|
||||
|
||||
If the search isn't working, check the JSON validity in the search.json file in your output folder. Usually something is invalid. Identify the problematic line, fix the file, or put `search: exclude` in the frontmatter of the file to exclude it from search.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -5,8 +5,6 @@ last_updated: March 20, 2016
|
||||
summary: "You can use a variety of text editors when working with a Jekyll project. WebStorm from IntelliJ offers a lot of project-specific features, such as find and replace, that make it ideal for working with tech comm projects."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_webstorm_text_editor/
|
||||
category: Authoring
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## About text editors and WebStorm
|
||||
@ -5,8 +5,6 @@ keywords: search
|
||||
summary: "YAML is a format that relies on white spacing to separate out the various elements of content. Jekyll lets you use Liquid with YAML as a way to parse through the data. Storing items for your table of contents is one of the most common uses of YAML with Jekyll."
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_yaml_tutorial/
|
||||
category: Navigation
|
||||
weight: 2
|
||||
---
|
||||
## Overview
|
||||
One of the most interesting features of Jekyll is the ability to separate out data elements from formatting elements using a combination of YAML and Liquid. This setup is most common when you're trying to create a table of contents.
|
||||
@ -7,37 +7,26 @@ toc: false
|
||||
---
|
||||
|
||||
<div class="home">
|
||||
|
||||
<div class="post-list">
|
||||
{% for post in site.posts limit:10 %}
|
||||
<h2>
|
||||
<a class="post-link" href="{{ post.url | prepend: site.baseurl }}">
|
||||
{{ post.title }}
|
||||
</a>
|
||||
</h2>
|
||||
<span class="post-meta">
|
||||
{{ post.date | date: "%b %-d, %Y" }} /
|
||||
|
||||
|
||||
<h2><a class="post-link" href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a></h2>
|
||||
<span class="post-meta">{{ post.date | date: "%b %-d, %Y" }} /
|
||||
{% for tag in post.tags %}
|
||||
<a href="{{ "/tag_" | prepend: site.baseurl | append: {{ tag }}/">
|
||||
{{tag}}
|
||||
</a>
|
||||
{% unless forloop.last %}, {% endunless%}
|
||||
<a href="{{ "/tag_" | prepend: site.baseurl | append: {{tag}}/">{{tag}}</a>{% unless forloop.last %}, {% endunless%}
|
||||
{% endfor %}</span>
|
||||
<p>
|
||||
{% if page.summary %}
|
||||
{{ page.summary | strip_html | strip_newlines | truncate: 160 }}
|
||||
{% else %}
|
||||
{{ post.content | truncatewords: 50 | strip_html }}
|
||||
{% endif %}
|
||||
</p>
|
||||
<p>{% if page.summary %} {{ page.summary | strip_html | strip_newlines | truncate: 160 }} {% else %} {{ post.content | truncatewords: 50 | strip_html }} {% endif %}</p>
|
||||
|
||||
|
||||
|
||||
{% endfor %}
|
||||
<p>
|
||||
<a href="{{ "/feed.xml" | prepend: site.baseurl }}" class="btn btn-primary navbar-btn cursorNorm" role="button">
|
||||
RSS Subscribe{{ tag }}
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p><a href="{{ "/feed.xml" | prepend: site.baseurl }}" class="btn btn-primary navbar-btn cursorNorm" role="button">RSS Subscribe{{tag}}</a></p>
|
||||
|
||||
<hr />
|
||||
<p>
|
||||
See more posts from the <a href="{{ "/news_archive/" | prepend: site.baseurl }}">News Archive</a>.
|
||||
</p>
|
||||
</div>
|
||||
<p>See more posts from the <a href="{{ "/news_archive/" | prepend: site.baseurl }}">News Archive</a>. </p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
@ -7,7 +7,10 @@ toc: false
|
||||
---
|
||||
|
||||
<div class="home">
|
||||
|
||||
<div class="post-list">
|
||||
|
||||
|
||||
<section id="archive">
|
||||
<h3>This year's posts</h3>
|
||||
{%for post in site.posts %}
|
||||
@ -22,15 +25,16 @@ toc: false
|
||||
<ul class="past">
|
||||
{% endif %}
|
||||
{% endunless %}
|
||||
<li>
|
||||
<time>{{ post.date | date:"%d %b" }}</time>
|
||||
<a href="{{ post.url | prepend: site.baseurl }}">
|
||||
{{ post.title }}
|
||||
</a>
|
||||
</li>
|
||||
<li><time>{{ post.date | date:"%d %b" }}</time><a href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
layout: null
|
||||
layout: none
|
||||
search: exclude
|
||||
---
|
||||
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: mydoc
|
||||
sidebar: product1_sidebar
|
||||
toc: false
|
||||
permalink: /p1_landing_page/
|
||||
category: Getting Started
|
||||
weight: 1
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-lg-12">
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample1/
|
||||
category: Getting Started
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample2/
|
||||
category: Getting Started
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample3/
|
||||
category: Getting Started
|
||||
weight: 4
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample4/
|
||||
category: Another heading
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample5/
|
||||
category: Another heading
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample6/
|
||||
category: Another heading
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample7/
|
||||
category: Another heading
|
||||
weight: 4
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -22,3 +20,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -4,8 +4,6 @@ keywords: mydoc
|
||||
sidebar: product2_sidebar
|
||||
toc: false
|
||||
permalink: /p2_landing_page/
|
||||
category: Introduction
|
||||
weight: 1
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-lg-12">
|
||||
@ -7,8 +7,6 @@ permalink: /p2_sample1/
|
||||
map: true
|
||||
map_name: usermap
|
||||
box_number: 1
|
||||
category: Simple Workflow
|
||||
weight: 1
|
||||
---
|
||||
|
||||
|
||||
@ -26,3 +24,4 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
|
||||
|
||||
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
|
||||
|
||||
@ -8,8 +8,6 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 2
|
||||
toc: false
|
||||
category: Complex Workflow
|
||||
weight: 5
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -8,8 +8,6 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 2
|
||||
toc: false
|
||||
category: Complex Workflow
|
||||
weight: 6
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -8,8 +8,6 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 3
|
||||
toc: false
|
||||
category: Complex Workflow
|
||||
weight: 7
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user