HPCE/gitea-pages
HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

committing new version of jekyll doc theme -- 5.0, with some refinements to come with the documentation

Browse Source
This commit is contained in:
tomjohnson1492 2016-03-19 00:13:09 -07:00
parent e267cce513
commit 7a869d7cd4
206 changed files with 16935 additions and 37629 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -1,3 +1,5 @@
_site/
.sass-cache/
.idea
.jekyll-metadata
_pdf
.idea/

6
Gemfile
View File

@ -1,6 +1,6 @@
source 'https://rubygems.org'
# A sample Gemfile
source "https://rubygems.org"
# gem "rails"
gem 'github-pages'
gem 'pygments.rb'
gem 'redcarpet'
gem 'jekyll'

42
Gemfile.lock
View File

@ -21,18 +21,18 @@ GEM
multipart-post (>= 1.2, < 3)
ffi (1.9.10)
gemoji (2.1.0)
github-pages (45)
github-pages (52)
RedCloth (= 4.2.9)
github-pages-health-check (= 0.6.0)
jekyll (= 3.0.2)
github-pages-health-check (= 1.0.1)
jekyll (= 3.0.3)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.3.1)
jekyll-feed (= 0.4.0)
jekyll-gist (= 1.4.0)
jekyll-mentions (= 1.0.0)
jekyll-mentions (= 1.0.1)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.9.1)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 0.1.4)
jekyll-seo-tag (= 1.3.1)
jekyll-sitemap (= 0.10.0)
jekyll-textile-converter (= 0.1.0)
jemoji (= 0.5.1)
@ -43,16 +43,17 @@ GEM
redcarpet (= 3.3.3)
rouge (= 1.10.1)
terminal-table (~> 1.4)
github-pages-health-check (0.6.0)
github-pages-health-check (1.0.1)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.3.0)
activesupport (>= 2, < 5)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.0.2)
jekyll (3.0.3)
colorator (~> 0.1)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
@ -63,19 +64,19 @@ GEM
safe_yaml (~> 1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.3.1)
jekyll-feed (0.4.0)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-mentions (1.0.0)
html-pipeline (~> 2.2)
jekyll-mentions (1.0.1)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.9.1)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (0.1.4)
jekyll (>= 2.0)
jekyll-seo-tag (1.3.1)
jekyll (~> 3.0)
jekyll-sitemap (0.10.0)
jekyll-textile-converter (0.1.0)
RedCloth (~> 4.0)
@ -88,9 +89,9 @@ GEM
json (1.8.3)
kramdown (1.9.0)
liquid (3.0.6)
listen (3.0.5)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
rb-inotify (>= 0.9.7)
mercenary (0.3.5)
mini_portile2 (2.0.0)
minitest (5.8.4)
@ -100,13 +101,9 @@ GEM
mini_portile2 (~> 2.0.0.rc2)
octokit (4.2.0)
sawyer (~> 0.6.0, >= 0.5.3)
posix-spawn (0.3.11)
public_suffix (1.5.3)
pygments.rb (0.6.3)
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.2.0)
rb-fsevent (0.9.7)
rb-inotify (0.9.5)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rdiscount (2.1.8)
redcarpet (3.3.3)
@ -122,7 +119,6 @@ GEM
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
yajl-ruby (1.2.1)
PLATFORMS
ruby
@ -130,8 +126,6 @@ PLATFORMS
DEPENDENCIES
github-pages
jekyll
pygments.rb
redcarpet
BUNDLED WITH
1.10.6
1.11.2

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2016 Tom Johnson
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

69
_config.yml
View File

@ -1,62 +1,30 @@
# this is simply copied over from config/config_designers.yml
# project definitions
project: mydoc_designers
audience: designers
product: doc
platform: all
version: all
permalink: /:year/:month/:day/:title/
url: http://idratherbewriting.com
baseurl: "/documentation-theme-jekyll"
output: web
destination: ../doc_outputs/mydoc/designers
topnav_title: Jekyll Documentation Theme
homepage_title: Jekyll doc theme for designers
site_title: Jekyll theme for designers
project_folder: mydoc
company_name: Your company
footer_image_location: ../../common_images/company_logo.png
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
disqus_shortname: idrbwjekyll
# variables
sidebar_tagline: Designers
sidebar_version: Version 4.0
theme_file: theme-blue.css
pdf_file_name: mydoc_designers_pdf.pdf
# the algolia entries here are experimental only.
#gems:
# - algoliasearch-jekyll
#algolia:
# application_id: 'HXUBJERYYB'
# index_name: 'documentation_theme_jekyll_designers'
host: 127.0.0.1
port: 4009
exclude:
- _site
- _drafts
- configs/
- doc/mydoc_writers*
# same for all
host: 127.0.0.1
feedback_email: tomjohnson1492@gmail.com
# these settings should work, but they don't seem to apply the right highlighting
#highlighter: rouge
#markdown: kramdown
#kramdown:
# input: GFM
# auto_ids: true
# hard_wrap: false
# syntax_highlighter: rouge
highlighter: pygments
markdown: redcarpet
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
highlighter: rouge
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
collections:
@ -72,6 +40,7 @@ defaults:
layout: "page"
comments: true
search: true
sidebar: home_sidebar
-
scope:
path: ""
@ -82,3 +51,17 @@ defaults:
search: true
tooltip: true
-
scope:
path: ""
type: "posts"
values:
layout: "post"
comments: true
search: true
sidebar: tags_sidebar
# the description is used in the feed.xml file
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."

0
_data/mydoc/mydoc_definitions.yml → _data/definitions.yml
View File

0
_data/mydoc/mydoc_glossary.yml → _data/glossary.yml
View File

634
_data/mydoc/mydoc_sidebar.yml
View File

@ -1,634 +0,0 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
# Sidebar
entries:
- title: Sidebar
subcategories:
- title:
audience: writers, designers
platform: all
product: all
version: all
output: pdf
type: frontmatter
items:
- title:
url: /titlepage.html
audience: writers, designers
platform: all
product: all
version: all
output: pdf
type: frontmatter
- title:
url: /tocpage.html
audience: writers, designers
platform: all
product: all
version: all
output: pdf
type: frontmatter
- title: Overview
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Introduction
url: /mydoc/home.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Supported features
url: /mydoc/mydoc_supported_features.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: About the theme author
url: /mydoc/mydoc_about.html
audience: writers, designers
platform: all
product: all
version: all
output: web
- title: Support
url: /mydoc/mydoc_support.html
audience: writers, designers
platform: all
product: all
version: all
output: web
- title: Get started
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: 1. Build the default project
url: /mydoc/mydoc_getting_started.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 2. Add a new project
url: /mydoc/mydoc_adding_new_projects.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 3. Decide on your project's attributes
url: /mydoc/mydoc_decide_on_attributes.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 4. Set the configuration options
url: /mydoc/mydoc_configuration_settings.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 5. Customize the conditions file
url: /mydoc/mydoc_conditions_file_customization.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 6. Configure the sidebar
url: /mydoc/mydoc_configure_sidebar.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 7. Configure the top navigation
url: /mydoc/mydoc_top_navigation.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 8. Customize the URL generator
url: /mydoc/mydoc_url_generator_customization.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 9. Set up Prince XML
url: /mydoc/mydoc_princexml_setup.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: 10. Configure the build scripts
url: /mydoc/mydoc_build_scripts.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Authoring
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Pages
url: /mydoc/mydoc_pages.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: WebStorm Text Editor
url: /mydoc/mydoc_webstorm_text_editor.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Conditional logic
url: /mydoc/mydoc_conditional_logic.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Content reuse
url: /mydoc/mydoc_content_reuse.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Collections
url: /mydoc/mydoc_collections.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Navigation
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Sidebar navigation
url: /mydoc/mydoc_sidebar_navigation.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: YAML tutorial in the context of Jekyll
url: /mydoc/mydoc_yaml_tutorial.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Tags
url: /mydoc/mydoc_tags.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Series
url: /mydoc/mydoc_series.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Formatting
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Tooltips
url: /mydoc/mydoc_adding_tooltips.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Alerts
url: /mydoc/mydoc_alerts.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Icons
url: /mydoc/mydoc_icons.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Images
url: /mydoc/mydoc_images.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Labels
url: /mydoc/mydoc_labels.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Links
url: /mydoc/mydoc_hyperlinks.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Navtabs
url: /mydoc/mydoc_navtabs.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Video embeds
url: /mydoc/mydoc_video_embeds.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Tables
url: /mydoc/mydoc_tables.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Syntax highlighting
url: /mydoc/mydoc_syntax_highlighting.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Handling reviews
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Commenting on files
url: /mydoc/mydoc_commenting_on_files.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Publishing
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Build arguments
url: /mydoc/mydoc_build_arguments.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Themes
url: /mydoc/mydoc_themes.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Link validation
url: /mydoc/mydoc_link_validation.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Check page title consistency
url: /mydoc/mydoc_title_checker.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Generating PDFs
url: /mydoc/mydoc_generating_pdfs.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Excluding files
url: /mydoc/mydoc_excluding_files.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Help APIs and UI tooltips
url: /mydoc/mydoc_help_api.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Search configuration
url: /mydoc/mydoc_search_configuration.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: iTerm profiles
url: /mydoc/mydoc_iterm_profiles.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Pushing builds to server
url: /mydoc/mydoc_push_build_to_server.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Getting around the password prompts in SCP
url: /mydoc/mydoc_no_password_prompts_scp.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Special layouts
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Knowledge-base layout
url: /mydoc/mydoc_kb_layout.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Scroll layout
url: /mydoc/mydoc_scroll.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Shuffle layout
url: /mydoc/mydoc_shuffle.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: FAQ layout
url: /mydoc/mydoc_faq.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Glossary layout
url: /mydoc/mydoc_glossary.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Algolia search
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Configuring Algolia search
url: /mydoc/mydoc_algoliasearch.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Collaborating with version control
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Mercurial notes and tips
url: /mydoc/mydoc_mercurial_collaboration.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
# - title: Git notes and tips
# url: /mydoc/mydoc_git_collaboration.html
# audience: writers, designers
# platform: all
# product: all
# version: all
# output: web, pdf
- title: Troubleshooting
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
items:
- title: Troubleshooting
url: /mydoc/mydoc_troubleshooting.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Adding all project dependencies
url: /mydoc/mydoc_install_dependencies.html
audience: writers, designers
platform: all
product: all
version: all
output: web, pdf
- title: Tag archives
audience: writers, designers
platform: all
product: all
version: all
output: web
items:
- title: Tag archives overview
url: /mydoc/mydoc_tag_archives_overview.html
audience: writers, designers
platform: all
product: all
version: all
output: web
thirdlevel:
- title: Tag archive pages
audience: writers, designers
platform: all
version: all
product: all
output: web
thirdlevelitems:
- title: Getting started pages
url: /mydoc/tag_getting_started.html
audience: writers, designers
platform: all
version: all
product: all
output: web
- title: Formatting pages
url: /mydoc/tag_formatting.html
audience: writers, designers
platform: all
version: all
product: all
output: web
- title: Navigation pages
url: /mydoc/tag_navigation.html
audience: writers, designers
platform: all
version: all
product: all
output: web
- title: Content types pages
url: /mydoc/tag_content_types.html
audience: writers, designers
platform: all
version: all
product: all
output: web
- title: Publishing pages
url: /mydoc/tag_publishing.html
audience: writers, designers
platform: all
version: all
product: all
output: web
- title: Special layout pages
url: /mydoc/tag_special_layouts.html
audience: writers, designers
platform: all
version: all
product: all
output: web
- title: Collaboration pages
url: /mydoc/tag_collaboration.html
audience: writers, designers
platform: all
version: all
product: all
output: web

63
_data/mydoc/mydoc_topnav.yml
View File

@ -1,63 +0,0 @@
## 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
subcategories:
# - title: Sample
# url: /mydoc/sample.html
# audience: writers, designers
# platform: all
# product: all
# version: all
# output: web
- title: Github Repo
external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll
audience: writers, designers
platform: all
product: all
version: all
output: web
#Topnav dropdowns
topnav_dropdowns:
- title: Topnav dropdowns
subcategories:
- title: Jekyll Resources
audience: writers, designers
platform: all
product: all
version: all
output: web
items:
- title: Jekyll Talk
external_url: https://talk.jekyllrb.com
audience: writers, designers
platform: all
product: all
version: all
output: web
- title: Jekyll documentation
external_url: http://jekyllrb.com/docs/home/
audience: writers, designers
platform: all
product: all
version: all
output: web
- title: Jekyll on Stack Overflow
external_url: http://stackoverflow.com/questions/tagged/jekyll
audience: writers, designers
platform: all
product: all
version: all
output: web
- title: Jekyll on my blog
external_url: http://idratherbewriting.com/category-jekyll/
audience: writers, designers
platform: all
product: all
version: all
output: web

494
_data/mydoc/mydoc_urls.yml
View File

@ -1,494 +0,0 @@
home:
title: "Introduction"
url: "../mydoc/home.html"
link: "<a href='../mydoc/home.html'>Introduction</a>"
mydoc_supported_features:
title: "Supported features"
url: "../mydoc/mydoc_supported_features.html"
link: "<a href='../mydoc/mydoc_supported_features.html'>Supported features</a>"
mydoc_about:
title: "About the theme author"
url: "../mydoc/mydoc_about.html"
link: "<a href='../mydoc/mydoc_about.html'>About the theme author</a>"
mydoc_support:
title: "Support"
url: "../mydoc/mydoc_support.html"
link: "<a href='../mydoc/mydoc_support.html'>Support</a>"
mydoc_getting_started:
title: "1. Build the default project"
url: "../mydoc/mydoc_getting_started.html"
link: "<a href='../mydoc/mydoc_getting_started.html'>1. Build the default project</a>"
mydoc_adding_new_projects:
title: "2. Add a new project"
url: "../mydoc/mydoc_adding_new_projects.html"
link: "<a href='../mydoc/mydoc_adding_new_projects.html'>2. Add a new project</a>"
mydoc_decide_on_attributes:
title: "3. Decide on your project's attributes"
url: "../mydoc/mydoc_decide_on_attributes.html"
link: "<a href='../mydoc/mydoc_decide_on_attributes.html'>3. Decide on your project's attributes</a>"
mydoc_configuration_settings:
title: "4. Set the configuration options"
url: "../mydoc/mydoc_configuration_settings.html"
link: "<a href='../mydoc/mydoc_configuration_settings.html'>4. Set the configuration options</a>"
mydoc_conditions_file_customization:
title: "5. Customize the conditions file"
url: "../mydoc/mydoc_conditions_file_customization.html"
link: "<a href='../mydoc/mydoc_conditions_file_customization.html'>5. Customize the conditions file</a>"
mydoc_configure_sidebar:
title: "6. Configure the sidebar"
url: "../mydoc/mydoc_configure_sidebar.html"
link: "<a href='../mydoc/mydoc_configure_sidebar.html'>6. Configure the sidebar</a>"
mydoc_top_navigation:
title: "7. Configure the top navigation"
url: "../mydoc/mydoc_top_navigation.html"
link: "<a href='../mydoc/mydoc_top_navigation.html'>7. Configure the top navigation</a>"
mydoc_url_generator_customization:
title: "8. Customize the URL generator"
url: "../mydoc/mydoc_url_generator_customization.html"
link: "<a href='../mydoc/mydoc_url_generator_customization.html'>8. Customize the URL generator</a>"
mydoc_princexml_setup:
title: "9. Set up Prince XML"
url: "../mydoc/mydoc_princexml_setup.html"
link: "<a href='../mydoc/mydoc_princexml_setup.html'>9. Set up Prince XML</a>"
mydoc_build_scripts:
title: "10. Configure the build scripts"
url: "../mydoc/mydoc_build_scripts.html"
link: "<a href='../mydoc/mydoc_build_scripts.html'>10. Configure the build scripts</a>"
mydoc_pages:
title: "Pages"
url: "../mydoc/mydoc_pages.html"
link: "<a href='../mydoc/mydoc_pages.html'>Pages</a>"
mydoc_webstorm_text_editor:
title: "WebStorm Text Editor"
url: "../mydoc/mydoc_webstorm_text_editor.html"
link: "<a href='../mydoc/mydoc_webstorm_text_editor.html'>WebStorm Text Editor</a>"
mydoc_conditional_logic:
title: "Conditional logic"
url: "../mydoc/mydoc_conditional_logic.html"
link: "<a href='../mydoc/mydoc_conditional_logic.html'>Conditional logic</a>"
mydoc_content_reuse:
title: "Content reuse"
url: "../mydoc/mydoc_content_reuse.html"
link: "<a href='../mydoc/mydoc_content_reuse.html'>Content reuse</a>"
mydoc_collections:
title: "Collections"
url: "../mydoc/mydoc_collections.html"
link: "<a href='../mydoc/mydoc_collections.html'>Collections</a>"
mydoc_sidebar_navigation:
title: "Sidebar navigation"
url: "../mydoc/mydoc_sidebar_navigation.html"
link: "<a href='../mydoc/mydoc_sidebar_navigation.html'>Sidebar navigation</a>"
mydoc_yaml_tutorial:
title: "YAML tutorial in the context of Jekyll"
url: "../mydoc/mydoc_yaml_tutorial.html"
link: "<a href='../mydoc/mydoc_yaml_tutorial.html'>YAML tutorial in the context of Jekyll</a>"
mydoc_tags:
title: "Tags"
url: "../mydoc/mydoc_tags.html"
link: "<a href='../mydoc/mydoc_tags.html'>Tags</a>"
mydoc_series:
title: "Series"
url: "../mydoc/mydoc_series.html"
link: "<a href='../mydoc/mydoc_series.html'>Series</a>"
mydoc_adding_tooltips:
title: "Tooltips"
url: "../mydoc/mydoc_adding_tooltips.html"
link: "<a href='../mydoc/mydoc_adding_tooltips.html'>Tooltips</a>"
mydoc_alerts:
title: "Alerts"
url: "../mydoc/mydoc_alerts.html"
link: "<a href='../mydoc/mydoc_alerts.html'>Alerts</a>"
mydoc_icons:
title: "Icons"
url: "../mydoc/mydoc_icons.html"
link: "<a href='../mydoc/mydoc_icons.html'>Icons</a>"
mydoc_images:
title: "Images"
url: "../mydoc/mydoc_images.html"
link: "<a href='../mydoc/mydoc_images.html'>Images</a>"
mydoc_labels:
title: "Labels"
url: "../mydoc/mydoc_labels.html"
link: "<a href='../mydoc/mydoc_labels.html'>Labels</a>"
mydoc_hyperlinks:
title: "Links"
url: "../mydoc/mydoc_hyperlinks.html"
link: "<a href='../mydoc/mydoc_hyperlinks.html'>Links</a>"
mydoc_navtabs:
title: "Navtabs"
url: "../mydoc/mydoc_navtabs.html"
link: "<a href='../mydoc/mydoc_navtabs.html'>Navtabs</a>"
mydoc_video_embeds:
title: "Video embeds"
url: "../mydoc/mydoc_video_embeds.html"
link: "<a href='../mydoc/mydoc_video_embeds.html'>Video embeds</a>"
mydoc_tables:
title: "Tables"
url: "../mydoc/mydoc_tables.html"
link: "<a href='../mydoc/mydoc_tables.html'>Tables</a>"
mydoc_syntax_highlighting:
title: "Syntax highlighting"
url: "../mydoc/mydoc_syntax_highlighting.html"
link: "<a href='../mydoc/mydoc_syntax_highlighting.html'>Syntax highlighting</a>"
mydoc_commenting_on_files:
title: "Commenting on files"
url: "../mydoc/mydoc_commenting_on_files.html"
link: "<a href='../mydoc/mydoc_commenting_on_files.html'>Commenting on files</a>"
mydoc_build_arguments:
title: "Build arguments"
url: "../mydoc/mydoc_build_arguments.html"
link: "<a href='../mydoc/mydoc_build_arguments.html'>Build arguments</a>"
mydoc_themes:
title: "Themes"
url: "../mydoc/mydoc_themes.html"
link: "<a href='../mydoc/mydoc_themes.html'>Themes</a>"
mydoc_link_validation:
title: "Link validation"
url: "../mydoc/mydoc_link_validation.html"
link: "<a href='../mydoc/mydoc_link_validation.html'>Link validation</a>"
mydoc_title_checker:
title: "Check page title consistency"
url: "../mydoc/mydoc_title_checker.html"
link: "<a href='../mydoc/mydoc_title_checker.html'>Check page title consistency</a>"
mydoc_generating_pdfs:
title: "Generating PDFs"
url: "../mydoc/mydoc_generating_pdfs.html"
link: "<a href='../mydoc/mydoc_generating_pdfs.html'>Generating PDFs</a>"
mydoc_excluding_files:
title: "Excluding files"
url: "../mydoc/mydoc_excluding_files.html"
link: "<a href='../mydoc/mydoc_excluding_files.html'>Excluding files</a>"
mydoc_help_api:
title: "Help APIs and UI tooltips"
url: "../mydoc/mydoc_help_api.html"
link: "<a href='../mydoc/mydoc_help_api.html'>Help APIs and UI tooltips</a>"
mydoc_search_configuration:
title: "Search configuration"
url: "../mydoc/mydoc_search_configuration.html"
link: "<a href='../mydoc/mydoc_search_configuration.html'>Search configuration</a>"
mydoc_iterm_profiles:
title: "iTerm profiles"
url: "../mydoc/mydoc_iterm_profiles.html"
link: "<a href='../mydoc/mydoc_iterm_profiles.html'>iTerm profiles</a>"
mydoc_push_build_to_server:
title: "Pushing builds to server"
url: "../mydoc/mydoc_push_build_to_server.html"
link: "<a href='../mydoc/mydoc_push_build_to_server.html'>Pushing builds to server</a>"
mydoc_no_password_prompts_scp:
title: "Getting around the password prompts in SCP"
url: "../mydoc/mydoc_no_password_prompts_scp.html"
link: "<a href='../mydoc/mydoc_no_password_prompts_scp.html'>Getting around the password prompts in SCP</a>"
mydoc_kb_layout:
title: "Knowledge-base layout"
url: "../mydoc/mydoc_kb_layout.html"
link: "<a href='../mydoc/mydoc_kb_layout.html'>Knowledge-base layout</a>"
mydoc_scroll:
title: "Scroll layout"
url: "../mydoc/mydoc_scroll.html"
link: "<a href='../mydoc/mydoc_scroll.html'>Scroll layout</a>"
mydoc_shuffle:
title: "Shuffle layout"
url: "../mydoc/mydoc_shuffle.html"
link: "<a href='../mydoc/mydoc_shuffle.html'>Shuffle layout</a>"
mydoc_faq:
title: "FAQ layout"
url: "../mydoc/mydoc_faq.html"
link: "<a href='../mydoc/mydoc_faq.html'>FAQ layout</a>"
mydoc_glossary:
title: "Glossary layout"
url: "../mydoc/mydoc_glossary.html"
link: "<a href='../mydoc/mydoc_glossary.html'>Glossary layout</a>"
mydoc_algoliasearch:
title: "Configuring Algolia search"
url: "../mydoc/mydoc_algoliasearch.html"
link: "<a href='../mydoc/mydoc_algoliasearch.html'>Configuring Algolia search</a>"
mydoc_mercurial_collaboration:
title: "Mercurial notes and tips"
url: "../mydoc/mydoc_mercurial_collaboration.html"
link: "<a href='../mydoc/mydoc_mercurial_collaboration.html'>Mercurial notes and tips</a>"
mydoc_troubleshooting:
title: "Troubleshooting"
url: "../mydoc/mydoc_troubleshooting.html"
link: "<a href='../mydoc/mydoc_troubleshooting.html'>Troubleshooting</a>"
mydoc_install_dependencies:
title: "Adding all project dependencies"
url: "../mydoc/mydoc_install_dependencies.html"
link: "<a href='../mydoc/mydoc_install_dependencies.html'>Adding all project dependencies</a>"
mydoc_tag_archives_overview:
title: "Tag archives overview"
url: "../mydoc/mydoc_tag_archives_overview.html"
link: "<a href='../mydoc/mydoc_tag_archives_overview.html'>Tag archives overview</a>"
tag_getting_started:
title: "Getting started pages"
url: "../mydoc/tag_getting_started.html"
link: "<a href='../mydoc/tag_getting_started.html'>Getting started pages</a>"
tag_formatting:
title: "Formatting pages"
url: "../mydoc/tag_formatting.html"
link: "<a href='../mydoc/tag_formatting.html'>Formatting pages</a>"
tag_navigation:
title: "Navigation pages"
url: "../mydoc/tag_navigation.html"
link: "<a href='../mydoc/tag_navigation.html'>Navigation pages</a>"
tag_content_types:
title: "Content types pages"
url: "../mydoc/tag_content_types.html"
link: "<a href='../mydoc/tag_content_types.html'>Content types pages</a>"
tag_publishing:
title: "Publishing pages"
url: "../mydoc/tag_publishing.html"
link: "<a href='../mydoc/tag_publishing.html'>Publishing pages</a>"
tag_special_layouts:
title: "Special layout pages"
url: "../mydoc/tag_special_layouts.html"
link: "<a href='../mydoc/tag_special_layouts.html'>Special layout pages</a>"
tag_collaboration:
title: "Collaboration pages"
url: "../mydoc/tag_collaboration.html"
link: "<a href='../mydoc/tag_collaboration.html'>Collaboration pages</a>"

494
_data/mydoc_urls.yml Normal file
View File

@ -0,0 +1,494 @@
home:
title: "Introduction"
url: "mydoc/home.html"
link: "<a href='mydoc/home.html'>Introduction</a>"
mydoc_supported_features:
title: "Supported features"
url: "mydoc/mydoc_supported_features.html"
link: "<a href='mydoc/mydoc_supported_features.html'>Supported features</a>"
mydoc_about:
title: "About the theme author"
url: "mydoc/mydoc_about.html"
link: "<a href='mydoc/mydoc_about.html'>About the theme author</a>"
mydoc_support:
title: "Support"
url: "mydoc/mydoc_support.html"
link: "<a href='mydoc/mydoc_support.html'>Support</a>"
mydoc_getting_started:
title: "1. Build the default project"
url: "mydoc/mydoc_getting_started.html"
link: "<a href='mydoc/mydoc_getting_started.html'>1. Build the default project</a>"
mydoc_adding_new_projects:
title: "2. Add a new project"
url: "mydoc/mydoc_adding_new_projects.html"
link: "<a href='mydoc/mydoc_adding_new_projects.html'>2. Add a new project</a>"
mydoc_decide_on_attributes:
title: "3. Decide on your project's attributes"
url: "mydoc/mydoc_decide_on_attributes.html"
link: "<a href='mydoc/mydoc_decide_on_attributes.html'>3. Decide on your project's attributes</a>"
mydoc_configuration_settings:
title: "4. Set the configuration options"
url: "mydoc/mydoc_configuration_settings.html"
link: "<a href='mydoc/mydoc_configuration_settings.html'>4. Set the configuration options</a>"
mydoc_conditions_file_customization:
title: "5. Customize the conditions file"
url: "mydoc/mydoc_conditions_file_customization.html"
link: "<a href='mydoc/mydoc_conditions_file_customization.html'>5. Customize the conditions file</a>"
mydoc_configure_sidebar:
title: "6. Configure the sidebar"
url: "mydoc/mydoc_configure_sidebar.html"
link: "<a href='mydoc/mydoc_configure_sidebar.html'>6. Configure the sidebar</a>"
mydoc_top_navigation:
title: "7. Configure the top navigation"
url: "mydoc/mydoc_top_navigation.html"
link: "<a href='mydoc/mydoc_top_navigation.html'>7. Configure the top navigation</a>"
mydoc_url_generator_customization:
title: "8. Customize the URL generator"
url: "mydoc/mydoc_url_generator_customization.html"
link: "<a href='mydoc/mydoc_url_generator_customization.html'>8. Customize the URL generator</a>"
mydoc_princexml_setup:
title: "9. Set up Prince XML"
url: "mydoc/mydoc_princexml_setup.html"
link: "<a href='mydoc/mydoc_princexml_setup.html'>9. Set up Prince XML</a>"
mydoc_build_scripts:
title: "10. Configure the build scripts"
url: "mydoc/mydoc_build_scripts.html"
link: "<a href='mydoc/mydoc_build_scripts.html'>10. Configure the build scripts</a>"
mydoc_pages:
title: "Pages"
url: "mydoc/mydoc_pages.html"
link: "<a href='mydoc/mydoc_pages.html'>Pages</a>"
mydoc_webstorm_text_editor:
title: "WebStorm Text Editor"
url: "mydoc/mydoc_webstorm_text_editor.html"
link: "<a href='mydoc/mydoc_webstorm_text_editor.html'>WebStorm Text Editor</a>"
mydoc_conditional_logic:
title: "Conditional logic"
url: "mydoc/mydoc_conditional_logic.html"
link: "<a href='mydoc/mydoc_conditional_logic.html'>Conditional logic</a>"
mydoc_content_reuse:
title: "Content reuse"
url: "mydoc/mydoc_content_reuse.html"
link: "<a href='mydoc/mydoc_content_reuse.html'>Content reuse</a>"
mydoc_collections:
title: "Collections"
url: "mydoc/mydoc_collections.html"
link: "<a href='mydoc/mydoc_collections.html'>Collections</a>"
mydoc_sidebar_navigation:
title: "Sidebar navigation"
url: "mydoc/mydoc_sidebar_navigation.html"
link: "<a href='mydoc/mydoc_sidebar_navigation.html'>Sidebar navigation</a>"
mydoc_yaml_tutorial:
title: "YAML tutorial in the context of Jekyll"
url: "mydoc/mydoc_yaml_tutorial.html"
link: "<a href='mydoc/mydoc_yaml_tutorial.html'>YAML tutorial in the context of Jekyll</a>"
tags:
title: "Tags"
url: "mydoc/tags.html"
link: "<a href='mydoc/tags.html'>Tags</a>"
mydoc_series:
title: "Series"
url: "mydoc/mydoc_series.html"
link: "<a href='mydoc/mydoc_series.html'>Series</a>"
mydoc_adding_tooltips:
title: "Tooltips"
url: "mydoc/mydoc_adding_tooltips.html"
link: "<a href='mydoc/mydoc_adding_tooltips.html'>Tooltips</a>"
mydoc_alerts:
title: "Alerts"
url: "mydoc/mydoc_alerts.html"
link: "<a href='mydoc/mydoc_alerts.html'>Alerts</a>"
mydoc_icons:
title: "Icons"
url: "mydoc/mydoc_icons.html"
link: "<a href='mydoc/mydoc_icons.html'>Icons</a>"
mydoc_images:
title: "Images"
url: "mydoc/mydoc_images.html"
link: "<a href='mydoc/mydoc_images.html'>Images</a>"
mydoc_labels:
title: "Labels"
url: "mydoc/mydoc_labels.html"
link: "<a href='mydoc/mydoc_labels.html'>Labels</a>"
mydoc_hyperlinks:
title: "Links"
url: "mydoc/mydoc_hyperlinks.html"
link: "<a href='mydoc/mydoc_hyperlinks.html'>Links</a>"
mydoc_navtabs:
title: "Navtabs"
url: "mydoc/mydoc_navtabs.html"
link: "<a href='mydoc/mydoc_navtabs.html'>Navtabs</a>"
mydoc_video_embeds:
title: "Video embeds"
url: "mydoc/mydoc_video_embeds.html"
link: "<a href='mydoc/mydoc_video_embeds.html'>Video embeds</a>"
mydoc_tables:
title: "Tables"
url: "mydoc/mydoc_tables.html"
link: "<a href='mydoc/mydoc_tables.html'>Tables</a>"
mydoc_syntax_highlighting:
title: "Syntax highlighting"
url: "mydoc/mydoc_syntax_highlighting.html"
link: "<a href='mydoc/mydoc_syntax_highlighting.html'>Syntax highlighting</a>"
mydoc_commenting_on_files:
title: "Commenting on files"
url: "mydoc/mydoc_commenting_on_files.html"
link: "<a href='mydoc/mydoc_commenting_on_files.html'>Commenting on files</a>"
mydoc_build_arguments:
title: "Build arguments"
url: "mydoc/mydoc_build_arguments.html"
link: "<a href='mydoc/mydoc_build_arguments.html'>Build arguments</a>"
mydoc_themes:
title: "Themes"
url: "mydoc/mydoc_themes.html"
link: "<a href='mydoc/mydoc_themes.html'>Themes</a>"
mydoc_link_validation:
title: "Link validation"
url: "mydoc/mydoc_link_validation.html"
link: "<a href='mydoc/mydoc_link_validation.html'>Link validation</a>"
mydoc_title_checker:
title: "Check page title consistency"
url: "mydoc/mydoc_title_checker.html"
link: "<a href='mydoc/mydoc_title_checker.html'>Check page title consistency</a>"
mydoc_generating_pdfs:
title: "Generating PDFs"
url: "mydoc/mydoc_generating_pdfs.html"
link: "<a href='mydoc/mydoc_generating_pdfs.html'>Generating PDFs</a>"
mydoc_excluding_files:
title: "Excluding files"
url: "mydoc/mydoc_excluding_files.html"
link: "<a href='mydoc/mydoc_excluding_files.html'>Excluding files</a>"
mydoc_help_api:
title: "Help APIs and UI tooltips"
url: "mydoc/mydoc_help_api.html"
link: "<a href='mydoc/mydoc_help_api.html'>Help APIs and UI tooltips</a>"
mydoc_search_configuration:
title: "Search configuration"
url: "mydoc/mydoc_search_configuration.html"
link: "<a href='mydoc/mydoc_search_configuration.html'>Search configuration</a>"
mydoc_iterm_profiles:
title: "iTerm profiles"
url: "mydoc/mydoc_iterm_profiles.html"
link: "<a href='mydoc/mydoc_iterm_profiles.html'>iTerm profiles</a>"
mydoc_push_build_to_server:
title: "Pushing builds to server"
url: "mydoc/mydoc_push_build_to_server.html"
link: "<a href='mydoc/mydoc_push_build_to_server.html'>Pushing builds to server</a>"
mydoc_no_password_prompts_scp:
title: "Getting around the password prompts in SCP"
url: "mydoc/mydoc_no_password_prompts_scp.html"
link: "<a href='mydoc/mydoc_no_password_prompts_scp.html'>Getting around the password prompts in SCP</a>"
mydoc_kb_layout:
title: "Knowledge-base layout"
url: "mydoc/mydoc_kb_layout.html"
link: "<a href='mydoc/mydoc_kb_layout.html'>Knowledge-base layout</a>"
mydoc_scroll:
title: "Scroll layout"
url: "mydoc/mydoc_scroll.html"
link: "<a href='mydoc/mydoc_scroll.html'>Scroll layout</a>"
mydoc_shuffle:
title: "Shuffle layout"
url: "mydoc/mydoc_shuffle.html"
link: "<a href='mydoc/mydoc_shuffle.html'>Shuffle layout</a>"
mydoc_faq:
title: "FAQ layout"
url: "mydoc/mydoc_faq.html"
link: "<a href='mydoc/mydoc_faq.html'>FAQ layout</a>"
glossary:
title: "Glossary layout"
url: "mydoc/glossary.html"
link: "<a href='mydoc/glossary.html'>Glossary layout</a>"
mydoc_algoliasearch:
title: "Configuring Algolia search"
url: "mydoc/mydoc_algoliasearch.html"
link: "<a href='mydoc/mydoc_algoliasearch.html'>Configuring Algolia search</a>"
mydoc_mercurial_collaboration:
title: "Mercurial notes and tips"
url: "mydoc/mydoc_mercurial_collaboration.html"
link: "<a href='mydoc/mydoc_mercurial_collaboration.html'>Mercurial notes and tips</a>"
mydoc_troubleshooting:
title: "Troubleshooting"
url: "mydoc/mydoc_troubleshooting.html"
link: "<a href='mydoc/mydoc_troubleshooting.html'>Troubleshooting</a>"
mydoc_install_dependencies:
title: "Adding all project dependencies"
url: "mydoc/mydoc_install_dependencies.html"
link: "<a href='mydoc/mydoc_install_dependencies.html'>Adding all project dependencies</a>"
mydoc_tag_archives_overview:
title: "Tag archives overview"
url: "mydoc/mydoc_tag_archives_overview.html"
link: "<a href='mydoc/mydoc_tag_archives_overview.html'>Tag archives overview</a>"
tag_getting_started:
title: "Getting started pages"
url: "mydoc/tag_getting_started.html"
link: "<a href='mydoc/tag_getting_started.html'>Getting started pages</a>"
tag_formatting:
title: "Formatting pages"
url: "mydoc/tag_formatting.html"
link: "<a href='mydoc/tag_formatting.html'>Formatting pages</a>"
tag_navigation:
title: "Navigation pages"
url: "mydoc/tag_navigation.html"
link: "<a href='mydoc/tag_navigation.html'>Navigation pages</a>"
tag_content_types:
title: "Content types pages"
url: "mydoc/tag_content_types.html"
link: "<a href='mydoc/tag_content_types.html'>Content types pages</a>"
tag_publishing:
title: "Publishing pages"
url: "mydoc/tag_publishing.html"
link: "<a href='mydoc/tag_publishing.html'>Publishing pages</a>"
tag_special_layouts:
title: "Special layout pages"
url: "mydoc/tag_special_layouts.html"
link: "<a href='mydoc/tag_special_layouts.html'>Special layout pages</a>"
tag_collaboration:
title: "Collaboration pages"
url: "mydoc/tag_collaboration.html"
link: "<a href='mydoc/tag_collaboration.html'>Collaboration pages</a>"

0
_data/mydoc/samplelist.yml → _data/samplelist.yml
View File

26
_data/sidebars/home_sidebar.yml Normal file
View File

@ -0,0 +1,26 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
- title: Sidebar
levels: one
subcategories:
- title: Products
output: web
items:
- title: Home
url: /
output: web
- 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

244
_data/sidebars/mydoc_sidebar.yml Normal file
View File

@ -0,0 +1,244 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
- title: Mydoc
product: Mydoc
version: version 5.0
subcategories:
- title:
output: pdf
type: frontmatter
items:
- title:
url: /titlepage/
output: pdf
type: frontmatter
- title:
url: /tocpage/
output: pdf
type: frontmatter
- title: Overview
output: web, pdf
items:
- title: Introduction
url: /mydoc_introduction/
output: web, pdf
- title: Supported features
url: /mydoc_supported_features/
output: web, pdf
- title: Get started
url: /mydoc_getting_started/
output: web, pdf
- title: About the theme author
url: /mydoc_about/
output: web, pdf
- title: Support
url: /mydoc_support/
output: web, pdf
- title: Authoring
output: web, pdf
items:
- 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
items:
- 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
items:
- 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
items:
- title: Commenting on files
url: /mydoc_commenting_on_files/
output: web, pdf
- title: Publishing
output: web, pdf
items:
- 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: Special layouts
output: web, pdf
items:
- title: Knowledge-base layout
url: /mydoc_kb_layout/
output: web, pdf
- title: Glossary layout
url: /mydoc_glossary/
output: web, pdf
- title: Troubleshooting
output: web, pdf
items:
- title: Troubleshooting
url: /mydoc_troubleshooting/
output: web, pdf
- title: Adding all project dependencies
url: /mydoc_install_dependencies/
output: web, pdf
- title: Tag archives
output: web
items:
- title: Tag archives overview
url: /mydoc_tag_archives_overview/
output: web
thirdlevel:
- title: Tag archive pages
thirdlevelitems:
- title: Getting started pages
url: /tag_getting_started/
output: web
- 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

60
_data/sidebars/product1_sidebar.yml Normal file
View 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: version 1.0
subcategories:
- title:
output: pdf
type: frontmatter
items:
- title:
url: /titlepage/
output: pdf
type: frontmatter
- title:
url: /tocpage/
output: pdf
type: frontmatter
- title: Getting Started
output: web, pdf
items:
- 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
items:
- 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

65
_data/sidebars/product2_sidebar.yml Normal file
View File

@ -0,0 +1,65 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
- title: Product2
product: Product2
version: version 1.0
subcategories:
- title:
output: pdf
type: frontmatter
items:
- title:
url: /titlepage/
output: pdf
type: frontmatter
- title:
url: /tocpage/
output: pdf
type: frontmatter
- title: Getting Started
output: web, pdf
items:
- title: Product 2 home
url: /p2_landing_page/
output: web
- title: Sample 1
url: /p2_sample1/
output: web, pdf
- title: Sample 2
url: /p2_sample2/
output: web, pdf
- title: Another heading
output: web, pdf
items:
- title: Sample 3
url: /p2_sample3/
output: web, pdf
- title: Sample 4
url: /p2_sample4/
output: web, pdf
- title: Another heading
output: web, pdf
items:
- title: Sample 5
url: /p2_sample5/
output: web, pdf
- title: Sample 6
url: /p2_sample6/
output: web, pdf
- title: Sample 7
url: /p2_sample7/
output: web, pdf

36
_data/sidebars/tags_sidebar.yml Normal file
View File

@ -0,0 +1,36 @@
entries:
- title: Tags Sidebar
product: Tags
version: all products
levels: one
subcategories:
- title: News
items:
- title: News
url: /news/
- title: News archive
url: /news_archive/
- title: Tags
items:
- title: Collaboration
url: /tag_collaboration/
- title: Content Types
url: /tag_content_types/
- title: Formatting
url: /tag_formatting/
- title: Getting started
url: /tag_getting_started/
- title: Mobile
url: /tag_mobile/
- title: Navigation
url: /tag_navigation/
- title: News
url: /tag_news/
- title: Publishing
url: /tag_publishing/
- title: Single sourcing
url: /tag_single_sourcing/
- title: Special layouts
url: /tag_special_layouts/

3
_data/mydoc/mydoc_tags.yml → _data/tags.yml
View File

@ -6,4 +6,5 @@ allowed-tags:
- publishing
- single_sourcing
- special_layouts
- collaboration
- collaboration
- news

35
_data/topnav.yml Normal file
View File

@ -0,0 +1,35 @@
## 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
subcategories:
- title: News
url: /news/
#Topnav dropdowns
topnav_dropdowns:
- title: Topnav dropdowns
subcategories:
- title: Jekyll Resources
items:
- title: Github Repo
external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll
- title: Jekyll Talk
external_url: https://talk.jekyllrb.com
- title: Jekyll documentation
external_url: http://jekyllrb.com/docs/home/
- title: Jekyll on Stack Overflow
external_url: http://stackoverflow.com/questions/tagged/jekyll
- title: Jekyll on my blog
external_url: http://idratherbewriting.com/category-jekyll/
- title: Products
items:
- title: Theme instructions
url: /mydoc_introduction/
- title: Product 1
url: /p1_landing_page/
- title: Product 2
url: /p2_landing_page/

519
_data/urls.yml Normal file
View File

@ -0,0 +1,519 @@
mydoc_introduction:
title: "Introduction"
url: "mydoc_introduction"
link: "<a href='/mydoc_introduction/'>Introduction</a>"
mydoc_supported_features:
title: "Supported features"
url: "mydoc_supported_features"
link: "<a href='/mydoc_supported_features/'>Supported features</a>"
mydoc_getting_started:
title: "Get started"
url: "mydoc_getting_started"
link: "<a href='/mydoc_getting_started/'>Get started</a>"
mydoc_about:
title: "About the theme author"
url: "mydoc_about"
link: "<a href='/mydoc_about/'>About the theme author</a>"
mydoc_support:
title: "Support"
url: "mydoc_support"
link: "<a href='/mydoc_support/'>Support</a>"
mydoc_pages:
title: "Pages"
url: "mydoc_pages"
link: "<a href='/mydoc_pages/'>Pages</a>"
mydoc_posts:
title: "Posts"
url: "mydoc_posts"
link: "<a href='/mydoc_posts/'>Posts</a>"
mydoc_webstorm_text_editor:
title: "WebStorm Text Editor"
url: "mydoc_webstorm_text_editor"
link: "<a href='/mydoc_webstorm_text_editor/'>WebStorm Text Editor</a>"
mydoc_conditional_logic:
title: "Conditional logic"
url: "mydoc_conditional_logic"
link: "<a href='/mydoc_conditional_logic/'>Conditional logic</a>"
mydoc_content_reuse:
title: "Content reuse"
url: "mydoc_content_reuse"
link: "<a href='/mydoc_content_reuse/'>Content reuse</a>"
mydoc_collections:
title: "Collections"
url: "mydoc_collections"
link: "<a href='/mydoc_collections/'>Collections</a>"
mydoc_sidebar_navigation:
title: "Sidebar navigation"
url: "mydoc_sidebar_navigation"
link: "<a href='/mydoc_sidebar_navigation/'>Sidebar navigation</a>"
mydoc_yaml_tutorial:
title: "YAML tutorial in the context of Jekyll"
url: "mydoc_yaml_tutorial"
link: "<a href='/mydoc_yaml_tutorial/'>YAML tutorial in the context of Jekyll</a>"
mydoc_tags:
title: "Tags"
url: "mydoc_tags"
link: "<a href='/mydoc_tags/'>Tags</a>"
mydoc_series:
title: "Series"
url: "mydoc_series"
link: "<a href='/mydoc_series/'>Series</a>"
mydoc_adding_tooltips:
title: "Tooltips"
url: "mydoc_adding_tooltips"
link: "<a href='/mydoc_adding_tooltips/'>Tooltips</a>"
mydoc_alerts:
title: "Alerts"
url: "mydoc_alerts"
link: "<a href='/mydoc_alerts/'>Alerts</a>"
mydoc_icons:
title: "Icons"
url: "mydoc_icons"
link: "<a href='/mydoc_icons/'>Icons</a>"
mydoc_images:
title: "Images"
url: "mydoc_images"
link: "<a href='/mydoc_images/'>Images</a>"
mydoc_labels:
title: "Labels"
url: "mydoc_labels"
link: "<a href='/mydoc_labels/'>Labels</a>"
mydoc_hyperlinks:
title: "Links"
url: "mydoc_hyperlinks"
link: "<a href='/mydoc_hyperlinks/'>Links</a>"
mydoc_navtabs:
title: "Navtabs"
url: "mydoc_navtabs"
link: "<a href='/mydoc_navtabs/'>Navtabs</a>"
mydoc_video_embeds:
title: "Video embeds"
url: "mydoc_video_embeds"
link: "<a href='/mydoc_video_embeds/'>Video embeds</a>"
mydoc_tables:
title: "Tables"
url: "mydoc_tables"
link: "<a href='/mydoc_tables/'>Tables</a>"
mydoc_syntax_highlighting:
title: "Syntax highlighting"
url: "mydoc_syntax_highlighting"
link: "<a href='/mydoc_syntax_highlighting/'>Syntax highlighting</a>"
mydoc_commenting_on_files:
title: "Commenting on files"
url: "mydoc_commenting_on_files"
link: "<a href='/mydoc_commenting_on_files/'>Commenting on files</a>"
mydoc_build_arguments:
title: "Build arguments"
url: "mydoc_build_arguments"
link: "<a href='/mydoc_build_arguments/'>Build arguments</a>"
mydoc_themes:
title: "Themes"
url: "mydoc_themes"
link: "<a href='/mydoc_themes/'>Themes</a>"
mydoc_link_validation:
title: "Link validation"
url: "mydoc_link_validation"
link: "<a href='/mydoc_link_validation/'>Link validation</a>"
mydoc_title_checker:
title: "Check page title consistency"
url: "mydoc_title_checker"
link: "<a href='/mydoc_title_checker/'>Check page title consistency</a>"
mydoc_generating_pdfs:
title: "Generating PDFs"
url: "mydoc_generating_pdfs"
link: "<a href='/mydoc_generating_pdfs/'>Generating PDFs</a>"
mydoc_help_api:
title: "Help APIs and UI tooltips"
url: "mydoc_help_api"
link: "<a href='/mydoc_help_api/'>Help APIs and UI tooltips</a>"
mydoc_search_configuration:
title: "Search configuration"
url: "mydoc_search_configuration"
link: "<a href='/mydoc_search_configuration/'>Search configuration</a>"
mydoc_iterm_profiles:
title: "iTerm profiles"
url: "mydoc_iterm_profiles"
link: "<a href='/mydoc_iterm_profiles/'>iTerm profiles</a>"
mydoc_push_build_to_server:
title: "Pushing builds to server"
url: "mydoc_push_build_to_server"
link: "<a href='/mydoc_push_build_to_server/'>Pushing builds to server</a>"
mydoc_no_password_prompts_scp:
title: "Getting around the password prompts in SCP"
url: "mydoc_no_password_prompts_scp"
link: "<a href='/mydoc_no_password_prompts_scp/'>Getting around the password prompts in SCP</a>"
mydoc_kb_layout:
title: "Knowledge-base layout"
url: "mydoc_kb_layout"
link: "<a href='/mydoc_kb_layout/'>Knowledge-base layout</a>"
mydoc_glossary:
title: "Glossary layout"
url: "mydoc_glossary"
link: "<a href='/mydoc_glossary/'>Glossary layout</a>"
mydoc_troubleshooting:
title: "Troubleshooting"
url: "mydoc_troubleshooting"
link: "<a href='/mydoc_troubleshooting/'>Troubleshooting</a>"
mydoc_install_dependencies:
title: "Adding all project dependencies"
url: "mydoc_install_dependencies"
link: "<a href='/mydoc_install_dependencies/'>Adding all project dependencies</a>"
mydoc_tag_archives_overview:
title: "Tag archives overview"
url: "mydoc_tag_archives_overview"
link: "<a href='/mydoc_tag_archives_overview/'>Tag archives overview</a>"
tag_getting_started:
title: "Getting started pages"
url: "tag_getting_started"
link: "<a href='/tag_getting_started/'>Getting started pages</a>"
tag_formatting:
title: "Formatting pages"
url: "tag_formatting"
link: "<a href='/tag_formatting/'>Formatting pages</a>"
tag_navigation:
title: "Navigation pages"
url: "tag_navigation"
link: "<a href='/tag_navigation/'>Navigation pages</a>"
tag_content_types:
title: "Content types pages"
url: "tag_content_types"
link: "<a href='/tag_content_types/'>Content types pages</a>"
tag_publishing:
title: "Publishing pages"
url: "tag_publishing"
link: "<a href='/tag_publishing/'>Publishing pages</a>"
tag_special_layouts:
title: "Special layout pages"
url: "tag_special_layouts"
link: "<a href='/tag_special_layouts/'>Special layout pages</a>"
tag_collaboration:
title: "Collaboration pages"
url: "tag_collaboration"
link: "<a href='/tag_collaboration/'>Collaboration pages</a>"
p1_landing_page:
title: "Product 1 home"
url: "p1_landing_page"
link: "<a href='/p1_landing_page/'>Product 1 home</a>"
p1_sample1:
title: "Sample 1"
url: "p1_sample1"
link: "<a href='/p1_sample1/'>Sample 1</a>"
p1_sample2:
title: "Sample 2"
url: "p1_sample2"
link: "<a href='/p1_sample2/'>Sample 2</a>"
p1_sample3:
title: "Sample 3"
url: "p1_sample3"
link: "<a href='/p1_sample3/'>Sample 3</a>"
p1_sample4:
title: "Sample 4"
url: "p1_sample4"
link: "<a href='/p1_sample4/'>Sample 4</a>"
p1_sample5:
title: "Sample 5"
url: "p1_sample5"
link: "<a href='/p1_sample5/'>Sample 5</a>"
p1_sample6:
title: "Sample 6"
url: "p1_sample6"
link: "<a href='/p1_sample6/'>Sample 6</a>"
p1_sample7:
title: "Sample 7"
url: "p1_sample7"
link: "<a href='/p1_sample7/'>Sample 7</a>"
p2_landing_page:
title: "Product 2 home"
url: "p2_landing_page"
link: "<a href='/p2_landing_page/'>Product 2 home</a>"
p2_sample1:
title: "Sample 1"
url: "p2_sample1"
link: "<a href='/p2_sample1/'>Sample 1</a>"
p2_sample2:
title: "Sample 2"
url: "p2_sample2"
link: "<a href='/p2_sample2/'>Sample 2</a>"
p2_sample3:
title: "Sample 3"
url: "p2_sample3"
link: "<a href='/p2_sample3/'>Sample 3</a>"
p2_sample4:
title: "Sample 4"
url: "p2_sample4"
link: "<a href='/p2_sample4/'>Sample 4</a>"
p2_sample5:
title: "Sample 5"
url: "p2_sample5"
link: "<a href='/p2_sample5/'>Sample 5</a>"
p2_sample6:
title: "Sample 6"
url: "p2_sample6"
link: "<a href='/p2_sample6/'>Sample 6</a>"
p2_sample7:
title: "Sample 7"
url: "p2_sample7"
link: "<a href='/p2_sample7/'>Sample 7</a>"

40
_includes/algolia.html
View File

@ -1,40 +0,0 @@
<!-- this is an experimental of algolia search -->
<div class="search">
<input type="text" placeholder="search...">
</div>
<div class="results">
<ul id="users"></ul>
</div>
<script src="http://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
$(document).ready(function() {
var client = algoliasearch('{{site.algolia_application_id}}', '{{site.algolia_search_only_api_key}}');
var index = client.initIndex('{{site.algolia_index_name}}');
var $input = $('input');
$input.keyup(function() {
index.search($input.val(), {
hitsPerPage: 10,
facets: '*'
}, searchCallback);
}).focus();
});
function searchCallback(err, content) {
console.log(content);
if (err) {
console.error(err);
return;
}
var $users = $('#users');
$users.empty();
for (var i = 0; i < content.hits.length; i++) {
$users.append('<li> <a href="' + content.hits[i].url + '">' + content.hits[i].title + '</a> ' + content.hits[i]._highlightResult.body.value + '</li>');
}
};
</script>

42
_includes/custom/conditions.html
View File

@ -1,42 +0,0 @@
{% comment %}
__ __ _ _
\ \ / / __(_) |_ ___ _ __ ___
\ \ /\ / / '__| | __/ _ \ '__/ __|
\ V V /| | | | || __/ | \__ \
\_/\_/ |_| |_|\__\___|_| |___/
{% endcomment %}
{% if site.project == "mydoc_writers" %}
{% assign audience = "writers" %}
{% assign sidebar = site.data.mydoc.mydoc_sidebar.entries %}
{% assign topnav = site.data.mydoc.mydoc_topnav.topnav %}
{% assign topnav_dropdowns = site.data.mydoc.mydoc_topnav.topnav_dropdowns %}
{% assign version = "all" %}
{% assign product = "all" %}
{% assign platform = "all" %}
{% assign projectTags = site.data.mydoc.mydoc_tags.allowed-tags %}
{% assign projectFolder = "mydoc" %}
{% endif %}
{% comment %}
____ _
| _ \ ___ ___(_) __ _ _ __ ___ _ __ ___
| | | |/ _ \/ __| |/ _` | '_ \ / _ \ '__/ __|
| |_| | __/\__ \ | (_| | | | | __/ | \__ \
|____/ \___||___/_|\__, |_| |_|\___|_| |___/
|___/
{% endcomment %}
{% if site.project == "mydoc_designers" %}
{% assign audience = "designers" %}
{% assign sidebar = site.data.mydoc.mydoc_sidebar.entries %}
{% assign topnav = site.data.mydoc.mydoc_topnav.topnav %}
{% assign topnav_dropdowns = site.data.mydoc.mydoc_topnav.topnav_dropdowns %}
{% assign version = "all" %}
{% assign product = "all" %}
{% assign platform = "all" %}
{% assign projectTags = site.data.mydoc.mydoc_tags.allowed-tags %}
{% assign projectFolder = "mydoc" %}
{% endif %}

0
_includes/custom/mydoc/getting_started_series.html → _includes/custom/getting_started_series.html
View File

0
_includes/custom/mydoc/getting_started_series_next.html → _includes/custom/getting_started_series_next.html
View File

12
_includes/custom/mydoc/custom_menu.html
View File

@ -1,12 +0,0 @@
{% comment %} Note that in the preview server, this code won't work because the preview sites are using different ports. These links are all relative and assume the same port. However, when you publish the built sites onto the same server, then this toggle works fine. {% endcomment %}
<li class="dropdown">
<a href="#" class="dropdown-toggle otherProgLangs" data-toggle="dropdown">Custom Menu<b class="caret"></b></a>
<ul class="dropdown-menu">
<li {% if site.audience == "writers" %}class="dropdownActive"{% endif %}><a href="{% if page.homepage == true or page.switch == false %}../mydoc_writers/">Writer docs</a> {% else %} ../mydoc_writers{{page.url}}">Writer docs</a>{% endif %}</li>
<li {% if site.audience == "designers" %}class="dropdownActive"{% endif %}><a href="{% if page.homepage == true or page.switch == false %}../mydoc_designers/">Designer docs</a> {% else %} ../mydoc_designers{{page.url}}">Designer docs</a>{% endif %}</li>
</ul>
</li>

0
_includes/custom/mydoc/series_acme.html → _includes/custom/series_acme.html
View File

2
_includes/custom/mydoc/series_acme_next.html → _includes/custom/series_acme_next.html
View File

@ -1,7 +1,7 @@
<p>{% assign series_pages = site.tags.series_acme %}
{% for p in pages %}
{% if p.series == "ACME series" %}
{% assign nextTopic = page.weight | plus: "0.1" %}
{% assign nextTopic = page.weight | plus: "1" %}
{% if p.weight == nextTopic %}
<a href="{{p.url | prepend: '..'}}"><button type="button" class="btn btn-primary">Next: {{p.weight}} {{p.title}}</button></a>
{% endif %}

36
_includes/custom/sidebarconfigs.html Normal file
View File

@ -0,0 +1,36 @@
{% if page.sidebar == "home_sidebar" %}
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
{% elsif page.sidebar == "product1_sidebar" %}
{% assign sidebar = site.data.sidebars.product1_sidebar.entries %}
{% elsif page.sidebar == "product2_sidebar" %}
{% assign sidebar = site.data.sidebars.product2_sidebar.entries %}
{% elsif page.sidebar == "mydoc_sidebar" %}
{% assign sidebar = site.data.sidebars.mydoc_sidebar.entries %}
{% elsif page.sidebar == "tags_sidebar" %}
{% assign sidebar = site.data.sidebars.tags_sidebar.entries %}
{% else %}
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
{% endif %}
{% comment %}
sidebar configuration for print files
{% endcomment %}
{% if site.product == "mydoc" %}
{% assign sidebar_pdf = site.data.sidebars.mydoc_sidebar.entries %}
{% endif %}
{% if site.product == "product1" %}
{% assign sidebar_pdf = site.data.sidebars.product1_sidebar.entries %}
{% endif %}
{% if site.product == "product2" %}
{% assign sidebar_pdf = site.data.sidebars.product2_sidebar.entries %}
{% endif %}

2
_includes/footer.html
View File

@ -3,7 +3,7 @@
<div class="col-lg-12 footer">
&copy;{{ site.time | date: "%Y" }} {{site.company_name}}. All rights reserved. <br />
{% 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="{{site.footer_image_location}}"/></p>
<p><img src="{{ "/images/company_logo.png" | prepend: site.baseurl }}"/></p>
</div>
</div>
</footer>

25
_includes/frameescape.html
View File

@ -1,25 +0,0 @@
<script language="JavaScript" type="text/javascript">
$( document ).ready(function() {
// Handler for .ready() called.
if (top.location == location) {
$(".escapeMe").remove();
}
});
function breakout_of_frame() {
if (top.location != location) {
//top.location.href = document.location.href;
window.open(window.location.href, '_blank');
}
}
</script>
<li class="escapeMe">
<a href="#" onclick="breakout_of_frame()" ><i class="fa fa-sign-out"></i> Pop-out</a>
</li>

32
_includes/head.html
View File

@ -4,21 +4,28 @@
<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 == true %} {{site.homepage_title}} {% elsif page.title %}{{ page.title }}{% endif %} | {{ site.site_title }}</title>
<link rel="stylesheet" type="text/css" href="../css/syntax.css">
<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
<link rel="stylesheet" type="text/css" href="../css/modern-business.css">
<link rel="stylesheet" type="text/css" href="../css/lavish-bootstrap.css">
<link rel="stylesheet" type="text/css" href="../css/customstyles.css">
<link rel="stylesheet" type="text/css" href="../css/{{site.theme_file}}">
<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 }}">
<link rel="stylesheet" href="{{ "/css/theme-green.css" | prepend: site.baseurl }}">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="../js/jquery.navgoco.min.js"></script>
<script src="{{ "/js/jquery.navgoco.min.js" | prepend: site.baseurl }}"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="../js/toc.js"></script>
<script src="../js/customscripts.js"></script>
<link rel="shortcut icon" href="../common_images/favicon.ico" type="image/x-icon">
<script src="{{ "/js/toc.js" | prepend: site.baseurl }}"></script>
<script src="{{ "/js/customscripts.js" | prepend: site.baseurl }}"></script>
<link rrel="shortcut icon" href="{{ "/images/favicon.ico" | prepend: site.baseurl }}">
<!-- 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:// -->
<!--[if lt IE 9]>
@ -26,8 +33,7 @@
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}">

2
_includes/head_print.html
View File

@ -12,7 +12,7 @@
<link rel="stylesheet" href="{{ "/css/modern-business.css" | prepend: site.baseurl | prepend: site.url }}">
<link rel="stylesheet" href="{{ "/css/lavish-bootstrap.css" | prepend: site.baseurl | prepend: site.url }}">
<link rel="stylesheet" href="{{ "/css/customstyles.css" | prepend: site.baseurl | prepend: site.url }}">
<link rel="stylesheet" type="text/css" href="{{site.url}}/{{site.baseurl}}/css/{{site.theme_file}}">
<link rel="stylesheet" href="{{ "/css/theme-green.css" | prepend: site.baseurl | prepend: site.url }}">
<link rel="stylesheet" href="{{ "/css/syntax.css" | prepend: site.baseurl | prepend: site.url }}">
<link rel="stylesheet" href="{{ "/css/printstyles.css" | prepend: site.baseurl }}">

130
_includes/initialize_shuffle.html
View File

@ -1,130 +0,0 @@
<script type="text/javascript">
$(document).ready(function() {
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
});
</script>
<!-- shuffle -->
<script>
var shuffleme = (function( $ ) {
'use strict';
var $grid = $('#grid'),
$filterOptions = $('.filter-options'),
$sizer = $grid.find('.shuffle_sizer'),
init = function() {
// None of these need to be executed synchronously
setTimeout(function() {
listen();
setupFilters();
}, 100);
// instantiate the plugin
$grid.shuffle({
itemSelector: '[class*="col-"]',
sizer: $sizer
});
},
// Set up button clicks
setupFilters = function() {
var $btns = $filterOptions.children();
$btns.on('click', function() {
var $this = $(this),
isActive = $this.hasClass( 'active' ),
group = isActive ? 'all' : $this.data('group');
// Hide current label, show current label in title
if ( !isActive ) {
$('.filter-options .active').removeClass('active');
}
$this.toggleClass('active');
// Filter elements
$grid.shuffle( 'shuffle', group );
});
$btns = null;
},
// Re layout shuffle when images load. This is only needed
// below 768 pixels because the .picture-item height is auto and therefore
// the height of the picture-item is dependent on the image
// I recommend using imagesloaded to determine when an image is loaded
// but that doesn't support IE7
listen = function() {
var debouncedLayout = $.throttle( 300, function() {
$grid.shuffle('update');
});
// Get all images inside shuffle
$grid.find('img').each(function() {
var proxyImage;
// Image already loaded
if ( this.complete && this.naturalWidth !== undefined ) {
return;
}
// If none of the checks above matched, simulate loading on detached element.
proxyImage = new Image();
$( proxyImage ).on('load', function() {
$(this).off('load');
debouncedLayout();
});
proxyImage.src = this.src;
});
// Because this method doesn't seem to be perfect.
setTimeout(function() {
debouncedLayout();
}, 500);
};
return {
init: init
};
}( jQuery ));
$(document).ready(function() {
shuffleme.init();
});
</script>
<!-- new attempt-->
<script>
$(document).ready(function() {
/* initialize shuffle plugin */
var $grid = $('#grid');
$grid.shuffle({
itemSelector: '.item' // the selector for the items in the grid
});
});</script>
<script>
$('#filter a').click(function (e) {
e.preventDefault();
// set active class
$('#filter a').removeClass('active');
$(this).addClass('active');
// get group name from clicked item
var groupName = $(this).attr('data-group');
// reshuffle grid
$grid.shuffle('shuffle', groupName );
});</script>

28
_includes/related_pages.html
View File

@ -1,28 +0,0 @@
<hr />
<!-- code doesn't work -- tags work much better, but leaving this here in case i figure out the issue. -->
<h3>Related Pages</h3>
<ul id="related_pages">
{% assign currentTitle = page.title %}
{% for tag in page.tags %}
{% assign counter = '0' %}
{% for page in site.pages %}
{% if page.tags contains tag and page.title != currentTitle and counter < '10' %}
{% capture counter %}{{ counter | plus:'1' }}{% endcapture %}
{% assign pageList = "" | split: "|" %}
{{ pageList | push: page.title }}
{% endif %}
{% endfor %}
{% assign unique_pageList = pageList | uniq %}
{% for item in unique_pageList %}
<li><a href="{{ item.url}}">{{item.title}}</a></li>
{% endfor %}
{% if counter == '0' %}<span class="noOtherPages"><p>No other pages.</p></span>
{% endif %}
{% endfor %}
</ul>

30
_includes/sidebar.html
View File

@ -38,40 +38,40 @@
</script>
{% include custom/conditions.html %}
<ul id="mysidebar" class="nav">
<span class="siteTagline">{{site.sidebar_tagline}}</span>
<span class="versionTagline">{{site.sidebar_version}}</span>
{% include custom/sidebarconfigs.html %}
{% for entry in sidebar %}
{% for subcategory in entry.subcategories %}
{% if subcategory.audience contains audience and subcategory.product contains product and subcategory.platform contains platform and subcategory.version contains version and subcategory.output contains "web" %}
<span class="siteTagline">{{sidebar[0].product}}</span>
<span class="versionTagline">{{sidebar[0].version}}</span>
{% for entry in sidebar %}
{% for subcategory in entry.subcategories %}
{% if subcategory.output contains "web" %}
<li><a href="#">{{ subcategory.title }}</a>
<ul>
{% for item in subcategory.items %}
{% if item.audience contains audience and item.product contains product and item.platform contains platform and item.version contains version and item.output contains "web" %}
{% if item.output contains "web" %}
{% if item.external_url %}
<li><a href="{{item.external_url}}" target="_blank">{{subcategory.title}}</a></li>
{% elsif page.url == item.url %}
<li class="active"><a href="{{item.url | prepend: ".."}}">{{item.title}}</a></li>
<li class="active"><a href="{{item.url | prepend: site.baseurl}}">{{item.title}}</a></li>
{% else %}
<li><a href="{{item.url | prepend: ".."}}">{{item.title}}</a></li>
<li><a href="{{item.url | prepend: site.baseurl}}">{{item.title}}</a></li>
{% endif %}
{% for thirdlevel in item.thirdlevel %}
{% if thirdlevel.audience contains audience and thirdlevel.product contains product and thirdlevel.platform contains platform and thirdlevel.version contains version and thirdlevel.output contains "web" %}
{% if thirdlevel.output contains "web" %}
<li class="thirdlevel"><a href="#">{{ thirdlevel.title }}</a>
<ul>
{% for deeplevel in thirdlevel.thirdlevelitems %}
{% if deeplevel.audience contains audience and deeplevel.product contains product and deeplevel.platform contains platform and deeplevel.version contains version and deeplevel.output contains "web" %}
{% if deeplevel.output contains "web" %}
{% if deeplevel.external_url %}
<li><a href="{{deeplevel.external_url}}" target="_blank">{{deeplevel.title}}</a></li>
{% elsif page.url == deeplevel.url %}
<li class="active"><a href="{{deeplevel.url | prepend: ".."}}">{{deeplevel.title}}</a></li>
<li class="active"><a href="{{deeplevel.url | prepend: site.baseurl}}">{{deeplevel.title}}</a></li>
{% else %}
<li><a href="{{deeplevel.url | prepend: ".."}}">{{deeplevel.title}}</a></li>
<li><a href="{{deeplevel.url | prepend: site.baseurl}}">{{deeplevel.title}}</a></li>
{% endif %}
{% endif %}
@ -89,6 +89,8 @@
{% endfor %}
<!-- if you aren't using the accordion, uncomment this block:
<p class="external">

31
_includes/taglogic.html
View File

@ -1,16 +1,33 @@
<p>The following pages are tagged with <button type="button" style="cursor: default" class="btn btn-default navbar-btn">{{page.tagName}}</button></p>
<table><thead><tr><th>Page</th><th>Excerpt</th></tr></thead>
<p>The following pages and posts are tagged with <button type="button" style="cursor: default" class="btn btn-default navbar-btn">{{page.tagName}}</button></p>
<table><thead><tr><th>Title</th><th>Type</th><th>Excerpt</th></tr></thead>
<tbody>
{% assign thisTag = page.tagName %}
{% for page in site.pages %}
{% for tag in page.tags %}
{% if tag == thisTag %}
<tr><td><a href="{{ page.url | prepend: '..'}}">{{page.title}}</a></td>
<tr><td><a href="{{ page.url | prepend: site.baseurl }}">{{page.title}}</a></td>
<td><span class="label label-default">Page</span></td>
<td>{% if page.summary %} {{ page.summary | strip_html | strip_newlines | truncate: 160 }} {% else %} {{ page.content | truncatewords: 50 | strip_html }} {% endif %}</td>
</tr>
{% endif %}
{% endfor %}
{% endfor %}
</tbody>
</table>
{% endfor %}
{% assign thisTag = page.tagName %}
{% for post in site.posts %}
{% for tag in post.tags %}
{% if tag == thisTag %}
<tr><td><a href="{{ post.url | prepend: site.baseurl }}">{{post.title}}</a></td>
<td><span class="label label-primary">Post</span></td>
<td>{% if post.summary %} {{ post.summary | strip_html | strip_newlines | truncate: 160 }} {% else %} {{ post.content | truncatewords: 50 | strip_html }} {% endif %}</td>
</tr>
{% endif %}
{% endfor %}
{% endfor %}
</tbody>
</table>
</tbody>
</table>

45
_includes/topnav.html
View File

@ -9,25 +9,21 @@
<span class="icon-bar"></span>
</button>
<a class="fa fa-home fa-lg navbar-brand" href="home.html">&nbsp;<span class="projectTitle"> {{site.topnav_title}}</span></a>
<a class="fa fa-home fa-lg navbar-brand" href="{{site.baseurl}}/">&nbsp;<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 -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
{% include custom/conditions.html %}
{% for entry in topnav %}
{% for entry in site.data.topnav.topnav %}
{% for subcategory in entry.subcategories %}
{% if subcategory.audience contains audience and subcategory.product contains product and subcategory.platform contains platform and subcategory.version contains version and subcategory.output contains "web" %}
{% if subcategory.external_url %}
<li><a href="{{subcategory.external_url}}" target="_blank">{{subcategory.title}}</a></li>
{% elsif page.url == subcategory.url %}
<li class="active"><a href="{{subcategory.url | prepend: ".."}}">{{subcategory.title}}</a></li>
{% elsif page.url contains subcategory.url %}
<li class="active"><a href="{{subcategory.url | prepend: site.baseurl}}">{{subcategory.title}}</a></li>
{% else %}
<li><a href="{{subcategory.url | prepend: ".."}}">{{subcategory.title}}</a></li>
{% endif %}
<li><a href="{{subcategory.url | prepend: site.baseurl }}">{{subcategory.title}}</a></li>
{% endif %}
{% endfor %}
{% endfor %}
@ -36,53 +32,42 @@
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<li class="dropdown">
{% for entry in topnav_dropdowns %}
{% for entry in site.data.topnav.topnav_dropdowns %}
{% for subcategory in entry.subcategories %}
{% if subcategory.audience contains audience and subcategory.product contains product and subcategory.platform contains platform and subcategory.version contains version and subcategory.output contains "web" %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ subcategory.title }}<b class="caret"></b></a>
<ul class="dropdown-menu">
{% for subitem in subcategory.items %}
{% if subitem.audience contains audience and subitem.product contains product and subitem.platform contains platform and subcategory.version contains version and subitem.output contains "web" %}
{% if subitem.external_url %}
<li><a href="{{subitem.external_url}}" target="_blank">{{subitem.title}}</a></li>
{% elsif page.url contains subitem.url %}
<li class="dropdownActive"><a href="{{subitem.url}}">{{subitem.title}}</a></li>
<li class="dropdownActive"><a href="{{subitem.url | prepend: site.baseurl}}">{{subitem.title}}</a></li>
{% else %}
<li><a href="{{subitem.url | replace: "/",""}}">{{subitem.title}}</a></li>
{% endif %}
<li><a href="{{subitem.url | prepend: site.baseurl}}">{{subitem.title}}</a></li>
{% endif %}
{% endfor %}
{% endif %}
</ul>
</li>
{% endfor %}
{% endfor %}
<!-- special insertion -->
{% if site.project == "mydoc_designers" or site.project == "mydoc_writers" %}
{% comment %}
{% include custom/mydoc/custom_menu.html %}
{% endcomment %}
{% endif %}
{% include feedback.html %}
<!--uncomment this block if you want simple search instead of algolia-->
<!--comment out this block if you want to hide search-->
<li>
<!--start search-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="{{site.data.strings.search_placeholder_text}}">
<ul id="results-container"></ul>
</div>
<script src="../js/jekyll-search.js" type="text/javascript"></script>
<script src="{{ "/js/jekyll-search.js" | prepend: site.baseurl }}" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: '../search.json',
dataSource: '{{ "/search.json" | prepend: site.baseurl }}',
searchResultTemplate: '<li><a href="{url}" title="{{page.title | replace: "'", "\"}}">{title}</a></li>',
noResultsText: '{{site.data.strings.search_no_results_text}}',
limit: 10,
@ -92,9 +77,7 @@
<!--end search-->
</li>
{% comment %}
{% include frameescape.html %}
{% endcomment %}
</div>
<!-- /.container -->
</nav>

15
_layouts/archive.html
View File

@ -1,15 +0,0 @@
---
layout: default
type: archive
---
<div class="post-header">
<h1 class="post-title-main">{{ page.title }}</h1>
</div>
<div class="post-content">
{{ content }}
</div>

5
_layouts/default.html
View File

@ -9,7 +9,7 @@
})
</script>
{% if page.datatable == true %}
{% if page.datatable == "active" %}
<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>
@ -39,9 +39,6 @@
<!-- Content Column -->
<div class="col-md-9">
{% comment %}
{% include algolia.html %}
{% endcomment %}
{{content}}
</div><!-- /.row -->

20
_layouts/default_print.html
View File

@ -1,23 +1,23 @@
<!DOCTYPE html>
<html lang="en">
<html>
<head>
{% include head_print.html %}
<head>
{% include head_print.html %}
</head>
</head>
<body class="{% if page.type == "title"%}title{% elsif page.type == "frontmatter" %}frontmatter{% elsif page.type == "first_page" %}first_page{% endif %} print">
<!-- Page Content -->
<div class="container">
<!-- Content Column -->
<div class="col-md-9">
<!-- Page Content -->
<div class="container">
<!-- Content Column -->
<div class="col-md-9">
{{content}}
</div>
{{content}}
</div>
</div> <!-- /.container -->
</div> <!-- /.container -->
</body>

49
_layouts/endpoint.html
View File

@ -1,49 +0,0 @@
---
layout: default
---
<div class="post-header">
<h1 class="post-title-main">{% if page.homepage == true %} {{site.homepage_title}} {% else %}{{ page.title }}{% endif %}</h1>
</div>
<div class="post-content">
{% if page.summary %}
<div class="summary">{{page.summary}}</div>
{% endif %}
{% include toc.html %}
{% if site.github_editme_path %}
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
{% endif %}
<h2>sample link</h2>
samplelink: {{page.samplelink}}
samplelinktoo: {{page.samplelinktoo}}
<h2>Endpoint</h2>
{{page.paths.service/matchdevice.post.summary}}
<h2>hmac</h2>
{{page.securityDefinitions.hmac.type}}
{{content}}
<div class="tags">
{% if page.tags != null %}
<b>Tags: </b>
{% include custom/conditions.html %}
{% for tag in page.tags %}
{% if projectTags contains tag %}
<a href="tag_{{tag}}.html" class="btn btn-default navbar-btn cursorNorm" role="button">{{page.tagName}}{{tag}}</a>
{% endif %}
{% endfor %}
{% endif %}
</div>
{% include disqus.html %}
</div>
{{hr_shaded}}
{% include footer.html %}

18
_layouts/page.html
View File

@ -11,30 +11,40 @@ layout: default
{% if page.summary %}
<div class="summary">{{page.summary}}</div>
{% endif %}
{% include toc.html %}
{% unless page.toc == "none" %}
{% include toc.html %}
{% 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 %}
<b>Tags: </b>
{% include custom/conditions.html %}
{% assign projectTags = site.data.tags.allowed-tags %}
{% for tag in page.tags %}
{% if projectTags contains tag %}
<a href="tag_{{tag}}.html" class="btn btn-default navbar-btn cursorNorm" role="button">{{page.tagName}}{{tag}}</a>
<a href="{{ "/tag_" | prepend: site.baseurl | append: tag }}" class="btn btn-default navbar-btn cursorNorm" role="button">{{page.tagName}}{{tag}}</a>
{% endif %}
{% endfor %}
{% endif %}
</div>
{% if site.disqus %}
{% include disqus.html %}
{% endif %}
</div>
{{hr_shaded}}
{{site.data.alerts.hr_shaded}}
{% include footer.html %}

6
_layouts/page_print.html
View File

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

18
_layouts/page_search.html
View File

@ -1,18 +0,0 @@
---
layout: default
---
<div class="post-header">
<h1 class="post-title-main">{{ page.title }}</h1>
</div>
<div class="post-content">
{% include algolia.html %}
</div>
{{hr_shaded}}
{% include footer.html %}

45
_layouts/post.html Normal file
View File

@ -0,0 +1,45 @@
---
layout: default
---
<article class="post" itemscope itemtype="http://schema.org/BlogPosting">
<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 %}/
{% 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%}
{% 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 %}
{% include disqus.html %}
{% endif %}
{{site.data.alerts.hr_shaded}}
{% include footer.html %}

13
_layouts/tag_page.html
View File

@ -1,13 +0,0 @@
---
layout: default
---
<h2>{{ page.tag }}</h2>
<ul>
{% for post in page.posts %}
<li><a href="{{ post.url }}">{{ post.title }}</a> ({{ post.date | date_to_string }} | Tags: {{ post | tags }})</li>
{% endfor %}
</ul>
<div id="tag_cloud">
{{ site | tag_cloud }}
</div>

8
_posts/2015-04-12-test-post-last-year.md Normal file
View File

@ -0,0 +1,8 @@
---
title: "Test post from last year"
categories: jekyll update
permalink: /test-post-from-last-year/
tags: [news]
---
This is just a test post from the previous year.

17
_posts/2016-02-24-first-post.md Normal file
View File

@ -0,0 +1,17 @@
---
title: "Welcome to Jekyll!"
categories: jekyll update
permalink: /myupdate/
tags: [news]
---
Theme updates:
- Permalinks
- Kramdown
- URL specified in config file
- removed PDF output
- removed some of the alternative layouts
- added blog feature
- sidebars configurable per page

16
_posts/2016-02-26-sample-post-jekyll.md Normal file
View File

@ -0,0 +1,16 @@
---
title: "Sample post"
published: true
permalink: /samplepost/
summary: "This is some summary frontmatter for my sample post."
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
## Heading
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

6
_tooltips/baseball.html Normal file
View File

@ -0,0 +1,6 @@
---
id: baseball
product: mydoc
---
{{site.data.definitions.baseball}}

6
_tooltips/basketball.html Normal file
View File

@ -0,0 +1,6 @@
---
id: basketball
product: mydoc
---
{{site.data.definitions.basketball}}

6
_tooltips/football.html Normal file
View File

@ -0,0 +1,6 @@
---
id: football
product: mydoc
---
{{site.data.definitions.football}}

6
_tooltips/mydoc/baseball.html
View File

@ -1,6 +0,0 @@
---
id: baseball
product: mydoc
---
{{site.data.mydoc.mydoc_definitions.baseball}}

6
_tooltips/mydoc/basketball.html
View File

@ -1,6 +0,0 @@
---
id: basketball
product: mydoc
---
{{site.data.mydoc.mydoc_definitions.basketball}}

6
_tooltips/mydoc/football.html
View File

@ -1,6 +0,0 @@
---
id: football
product: mydoc
---
{{site.data.mydoc.mydoc_definitions.football}}

6
_tooltips/mydoc/soccer.html
View File

@ -1,6 +0,0 @@
---
id: soccer
product: mydoc
---
{{site.data.mydoc.mydoc_definitions.soccer}}

6
_tooltips/soccer.html Normal file
View File

@ -0,0 +1,6 @@
---
id: soccer
product: mydoc
---
{{site.data.definitions.soccer}}

23
algolia_search.json
View File

@ -1,23 +0,0 @@
---
title: search
layout: none
search: exclude
---
[
{% for page in site.pages %}
{% unless page.search == "exclude" %}
{
"title": "{{ page.title | escape }}",
"tags": "{{ page.tags }}",
"keywords": "{{page.keywords}}",
"url": "{{ page.url | prepend: '..' }}",
"summary": "{{page.summary}}",
"body": "{{ page.content | strip | strip_html | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' | replace: ' ', ' ' }}"
},
{% endunless %}
{% endfor %}
null
]

82
configs/mydoc/config_designers.yml
View File

@ -1,82 +0,0 @@
# project definitions
project: mydoc_designers
audience: designers
product: doc
platform: all
version: all
output: web
destination: ../doc_outputs/mydoc/designers
topnav_title: Jekyll Documentation Theme
homepage_title: Jekyll doc theme for designers
site_title: Jekyll theme for designers
project_folder: mydoc
company_name: Your company
footer_image_location: ../../common_images/company_logo.png
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
disqus_shortname: idrbwjekyll
# variables
sidebar_tagline: Designers
sidebar_version: Version 4.0
theme_file: theme-blue.css
pdf_file_name: mydoc_designers_pdf.pdf
# the algolia entries here are experimental only.
#gems:
# - algoliasearch-jekyll
#algolia:
# application_id: 'HXUBJERYYB'
# index_name: 'documentation_theme_jekyll_designers'
port: 4009
exclude:
- _site
- _drafts
- configs/
- doc/mydoc_writers*
# same for all
host: 127.0.0.1
feedback_email: tomjohnson1492@gmail.com
# these settings should work, but they don't seem to apply the right highlighting
#highlighter: rouge
#markdown: kramdown
#kramdown:
# input: GFM
# auto_ids: true
# hard_wrap: false
# syntax_highlighter: rouge
highlighter: pygments
markdown: redcarpet
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
collections:
tooltips:
output: false
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: true
search: true
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
comments: true
search: true
tooltip: true

81
configs/mydoc/config_writers.yml
View File

@ -1,81 +0,0 @@
# project definitions
project: mydoc_writers
audience: writers
product: doc
platform: all
version: all
output: web
destination: ../doc_outputs/mydoc/writers
topnav_title: Jekyll Documentation Theme
homepage_title: Jekyll doc theme for writers
site_title: Jekyll theme for writers
project_folder: mydoc
company_name: Your company
footer_image_location: ../../common_images/company_logo.png
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
disqus_shortname: idrbwjekyll
# variables
sidebar_tagline: Writers
sidebar_version: Version 4.0
theme_file: theme-green.css
pdf_file_name: mydoc_writers_pdf.pdf
# the algolia entries here are experimental only.
#gems:
# - algoliasearch-jekyll
#algolia:
# application_id: 'HXUBJERYYB'
# index_name: 'documentation_theme_jekyll_writers'
port: 4009
exclude:
- _site
- _drafts
- configs/
- doc/mydoc_writers*
# same for all
host: 127.0.0.1
feedback_email: tomjohnson1492@gmail.com
# these settings should work, but they don't seem to apply the right highlighting
#highlighter: rouge
#markdown: kramdown
#kramdown:
# input: GFM
# auto_ids: true
# hard_wrap: false
# syntax_highlighter: rouge
highlighter: pygments
markdown: redcarpet
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
collections:
tooltips:
output: false
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: true
search: true
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
comments: true
search: true
tooltip: true

2
css/bootstrap.min.css vendored
View File

File diff suppressed because one or more lines are too long

46
css/customstyles.css
View File

@ -378,9 +378,9 @@ text-decoration: none;
color: #f5f5f5;
}
.nav > li.active > a {
background-color: #347DBE;
}
/*.nav > li.active > a {*/
/*background-color: #347DBE;*/
/*}*/
.nav li a {
font-size: 12px;
@ -417,10 +417,13 @@ background-color: #FAFAFA;
}
.nav li a {
background-color: #EDEDED;
background-color: #e9e9e9;
padding-right:10px;
}
.nav li a:hover {
background-color: #8D8D8D;
}
.nav ul li a {
border-top:1px solid whitesmoke;
@ -707,7 +710,7 @@ ol.series li {
}
.siteTagline {
font-size: 300%;
font-size: 200%;
font-weight: bold;
color: silver;
font-family: monospace;
@ -969,7 +972,32 @@ div.results {
width: 100%;
}
.algolia__result-highlight {
background-color: yellow;
font-weight: bold;
}
.post-meta {
font-size: 14px;
color: #828282;
}
.post-link {
font-size: 22px;
}
.post-list p {
margin: 10px 0px;
}
time {
margin-right: 10px;
}
p.post-meta time {
margin-right: 0px;
}
span.label.label-default {
background-color: gray;
}
span.label.label-primary {
background-color: #f0ad4e;
}
.col-lg-12 .nav li a {background-color: white}

4
css/theme-blue.css
View File

@ -17,6 +17,10 @@ h4 {color: #808080; }
background-color: #347DBE;
}
.nav > li > a:hover {
background-color: #248ec2;
}
div.navbar-collapse .dropdown-menu > li > a:hover {
background-color: #347DBE;
}

4
css/theme-green.css
View File

@ -17,6 +17,10 @@ h4 {color: #808080; }
background-color: #72ac4a;
}
.nav > li > a:hover {
background-color: #72ac4a;
}
div.navbar-collapse .dropdown-menu > li > a:hover {
background-color: #72ac4a;
}

32
feed.xml Normal file
View File

@ -0,0 +1,32 @@
---
search: exclude
layout: none
---
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>{{ site.title | xml_escape }}</title>
<description>{{ site.description | xml_escape }}</description>
<link>{{ site.url }}{{ site.baseurl }}/</link>
<atom:link href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" rel="self" type="application/rss+xml"/>
<pubDate>{{ site.time | date_to_rfc822 }}</pubDate>
<lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate>
<generator>Jekyll v{{ jekyll.version }}</generator>
{% for post in site.posts limit:10 %}
<item>
<title>{{ post.title | xml_escape }}</title>
<description>{{ post.content | xml_escape }}</description>
<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 %}
</item>
{% endfor %}
</channel>
</rss>

0
mydoc/images/authorizegithubscreen2.png → images/authorizegithubscreen2.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 75 KiB

0
mydoc/images/authorizeongithub.png → images/authorizeongithub.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

0
common_images/company_logo.png → images/company_logo.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.0 KiB

After

Width:  |  Height:  |  Size: 3.0 KiB

0
common_images/company_logo_big.png → images/company_logo_big.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.4 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

0
common_images/favicon.ico → images/favicon.ico
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 173 KiB

After

Width:  |  Height:  |  Size: 173 KiB

0
mydoc/images/helpapi-01.png → images/helpapi-01.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 90 KiB

282
mydoc/images/helpapi.svg → images/helpapi.svg
View File

@ -1,94 +1,94 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 1200 900" enable-background="new 0 0 1200 900" xml:space="preserve">
<g id="Layer_1">
<rect fill="#9CCFEF" stroke="#000000" stroke-miterlimit="10" width="1200" height="900"/>
</g>
<g id="Layer_2">
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="470.4" y1="254.4" x2="197.8" y2="493.7"/>
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="740.8" y1="344.8" x2="890.8" y2="596.4"/>
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="801.2" y1="269.8" x2="1028.5" y2="426.2"/>
<g>
<g>
<path fill="#F2F2F2" d="M329.4,609.5c0,5.5-4.5,10-10,10H116c-5.5,0-10-4.5-10-10V503.7c0-5.5,4.5-10,10-10h203.4
c5.5,0,10,4.5,10,10V609.5z"/>
<path fill="none" stroke="#464747" stroke-width="22" stroke-miterlimit="10" d="M329.4,609.5c0,5.5-4.5,10-10,10H116
c-5.5,0-10-4.5-10-10V503.7c0-5.5,4.5-10,10-10h203.4c5.5,0,10,4.5,10,10V609.5z"/>
</g>
<rect x="124.7" y="523.8" fill="none" width="193.6" height="73.9"/>
<text transform="matrix(1 0 0 1 124.7476 533.7126)"><tspan x="0" y="0" font-family="'MyriadPro-Regular'" font-size="14">sample help text sample help </tspan><tspan x="0" y="16.8" font-family="'MyriadPro-Regular'" font-size="14">text sample help text sample </tspan><tspan x="0" y="33.6" font-family="'MyriadPro-Regular'" font-size="14">help text sample help text </tspan><tspan x="0" y="50.4" font-family="'MyriadPro-Regular'" font-size="14">sample help text sample help </tspan></text>
</g>
<radialGradient id="SVGID_1_" cx="329.75" cy="558.375" r="6.875" gradientUnits="userSpaceOnUse">
<stop offset="0" style="stop-color:#7A7A7A"/>
<stop offset="0.1457" style="stop-color:#767676"/>
<stop offset="0.3151" style="stop-color:#676767"/>
<stop offset="0.4963" style="stop-color:#505050"/>
<stop offset="0.6857" style="stop-color:#303030"/>
<stop offset="0.8799" style="stop-color:#060606"/>
<stop offset="0.9053" style="stop-color:#000000"/>
</radialGradient>
<circle fill="url(#SVGID_1_)" cx="329.8" cy="558.4" r="6.9"/>
<g>
<g>
<path fill="#050505" d="M590.2,815.3c-14.1-4.7-17.6-35.3-17.6-35.3c-0.6-5.5-4.4-9.9-8.4-10s-7.2,0-7.2-0.1c0,0-1,0-2.2,0
c-1.2,0-3.2,0-4.5,0c-1.2,0-2.3,0-2.3,0s-3.1,0-7,0.1c-3.8,0-7.5,4.5-8.1,10c0,0-3.4,30.6-17.4,35.3s-35.2,8.1-35.2,8.1
c-5.4,0.9-5.4,1.6,0.1,1.6H538c5.5,0,12,0,14.5,0s9,0,14.5,0h58.5c5.5,0,5.6-0.7,0.1-1.6C625.6,823.4,604.2,820,590.2,815.3z"/>
</g>
<g>
<path fill="#F2F2F2" d="M663,765.3c0,5.5-4.5,10-10,10H449.5c-5.5,0-10-4.5-10-10V622.1c0-5.5,4.5-10,10-10H653
c5.5,0,10,4.5,10,10V765.3z"/>
<path fill="none" stroke="#464747" stroke-width="5" stroke-miterlimit="10" d="M663,765.3c0,5.5-4.5,10-10,10H449.5
c-5.5,0-10-4.5-10-10V622.1c0-5.5,4.5-10,10-10H653c5.5,0,10,4.5,10,10V765.3z"/>
</g>
</g>
<rect x="461.5" y="630.6" fill="#CDF9F8" stroke="#565656" stroke-miterlimit="10" width="180.9" height="128"/>
<rect x="470.4" y="636.3" fill="none" width="172" height="121.2"/>
<text transform="matrix(1 0 0 1 470.4375 647.7349)"><tspan x="0" y="0" font-family="'ArialMT'" font-size="16">Getting Started </tspan><tspan x="0" y="19.2" font-family="'MyriadPro-Regular'" font-size="16">text sample help text </tspan><tspan x="0" y="38.4" font-family="'MyriadPro-Regular'" font-size="16">sample help text sample </tspan><tspan x="0" y="57.6" font-family="'MyriadPro-Regular'" font-size="16">help text sample help </tspan><tspan x="0" y="76.8" font-family="'MyriadPro-Regular'" font-size="16">text sample help text </tspan><tspan x="0" y="96" font-family="'MyriadPro-Regular'" font-size="16">sample help text sample </tspan></text>
<g>
<g>
<g>
<path fill="#050505" d="M976.4,778.4c-16.3-4.1-20.3-30.1-20.3-30.1c-0.8-5.4-5.3-9.9-9.9-9.9c-4.6,0-8.4,0-8.4-0.1
c0,0-1.2,0-2.6,0c-1.4,0-3.8,0-5.2,0c-1.5,0-2.6,0-2.6,0s-3.7,0-8.1,0.1c-4.5,0-8.8,4.5-9.5,9.9c0,0-3.7,26-20.1,30.1
c-16.3,4.1-42.5,7.4-42.5,7.4c-5.5,0.7-5.4,1.2,0.1,1.2h70.2c5.5,0,12.4,0,15.2,0c2.9,0,9.7,0,15.2,0h71.2
c5.5,0,5.5-0.5,0.1-1.2C1019.1,785.8,992.7,782.6,976.4,778.4z"/>
</g>
<g>
<path fill="#F2F2F2" d="M1061,733c0,5.5-4.5,10-10,10H811.2c-5.5,0-10-4.5-10-10V608.6c0-5.5,4.5-10,10-10H1051
c5.5,0,10,4.5,10,10V733z"/>
<path fill="none" stroke="#464747" stroke-width="5" stroke-miterlimit="10" d="M1061,733c0,5.5-4.5,10-10,10H811.2
c-5.5,0-10-4.5-10-10V608.6c0-5.5,4.5-10,10-10H1051c5.5,0,10,4.5,10,10V733z"/>
</g>
</g>
<rect x="811" y="606.8" fill="#F4E8C6" stroke="#565656" stroke-miterlimit="10" width="239.4" height="128"/>
<rect x="820.4" y="615.6" fill="none" width="220.6" height="110.5"/>
<text transform="matrix(1 0 0 1 820.4385 628.4581)"><tspan x="0" y="0" font-family="'ArialMT'" font-size="18">Learning Course</tspan><tspan x="0" y="21.6" font-family="'MyriadPro-Regular'" font-size="18">sample help text sample help </tspan><tspan x="0" y="43.2" font-family="'MyriadPro-Regular'" font-size="18">text sample help text sample </tspan><tspan x="0" y="64.8" font-family="'MyriadPro-Regular'" font-size="18">help text sample help text </tspan><tspan x="0" y="86.4" font-family="'MyriadPro-Regular'" font-size="18">sample help text sample help </tspan></text>
</g>
<g>
<path fill="#1E1E1E" d="M1080.8,544.5h-52.3c-4,0-7.2-3.2-7.2-7.2V433.4c0-4,3.2-7.2,7.2-7.2h52.3c4,0,7.2,3.2,7.2,7.2v103.8
C1088.1,541.2,1084.8,544.5,1080.8,544.5z"/>
<path fill="none" stroke="#565656" stroke-miterlimit="10" d="M1080.8,544.5h-52.3c-4,0-7.2-3.2-7.2-7.2V433.4
c0-4,3.2-7.2,7.2-7.2h52.3c4,0,7.2,3.2,7.2,7.2v103.8C1088.1,541.2,1084.8,544.5,1080.8,544.5z"/>
</g>
<path fill="#EAEAE8" stroke="#565656" stroke-miterlimit="10" d="M1081.5,525.8H1028c-0.8,0-1.5-0.7-1.5-1.5v-82.1
c0-0.8,0.7-1.5,1.5-1.5h53.5c0.8,0,1.5,0.7,1.5,1.5v82.1C1083,525.1,1082.3,525.8,1081.5,525.8z"/>
<radialGradient id="SVGID_2_" cx="1054.7556" cy="534.3206" r="5.6067" gradientUnits="userSpaceOnUse">
<stop offset="0" style="stop-color:#000000"/>
<stop offset="0.2375" style="stop-color:#030303"/>
<stop offset="0.4133" style="stop-color:#0C0C0C"/>
<stop offset="0.569" style="stop-color:#1C1C1C"/>
<stop offset="0.7133" style="stop-color:#333333"/>
<stop offset="0.8496" style="stop-color:#505050"/>
<stop offset="0.9782" style="stop-color:#747474"/>
<stop offset="1" style="stop-color:#7A7A7A"/>
</radialGradient>
<path fill="url(#SVGID_2_)" stroke="#565656" stroke-miterlimit="10" d="M1054.8,539.9L1054.8,539.9c-3.1,0-5.6-2.5-5.6-5.6l0,0
c0-3.1,2.5-5.6,5.6-5.6l0,0c3.1,0,5.6,2.5,5.6,5.6l0,0C1060.4,537.4,1057.8,539.9,1054.8,539.9z"/>
<rect x="1030.9" y="444" fill="none" width="52.3" height="76.1"/>
<text transform="matrix(1 0 0 1 1030.9103 449.4799)"><tspan x="0" y="0" font-family="'MyriadPro-Regular'" font-size="7.6892">sample help </tspan><tspan x="0" y="9.2" font-family="'MyriadPro-Regular'" font-size="7.6892">text sample </tspan><tspan x="0" y="18.5" font-family="'MyriadPro-Regular'" font-size="7.6892">help text </tspan><tspan x="0" y="27.7" font-family="'MyriadPro-Regular'" font-size="7.6892">sample help </tspan><tspan x="0" y="36.9" font-family="'MyriadPro-Regular'" font-size="7.6892">text sample </tspan><tspan x="0" y="46.1" font-family="'MyriadPro-Regular'" font-size="7.6892">help text </tspan><tspan x="0" y="55.4" font-family="'MyriadPro-Regular'" font-size="7.6892">sample help </tspan><tspan x="0" y="64.6" font-family="'MyriadPro-Regular'" font-size="7.6892">text sample </tspan></text>
<g>
<image overflow="visible" opacity="0.75" width="518" height="361" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgYAAAFpCAYAAADndeCyAAAACXBIWXMAAAsSAAALEgHS3X78AAAA
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 1200 900" enable-background="new 0 0 1200 900" xml:space="preserve">
<g id="Layer_1">
<rect fill="#9CCFEF" stroke="#000000" stroke-miterlimit="10" width="1200" height="900"/>
</g>
<g id="Layer_2">
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="470.4" y1="254.4" x2="197.8" y2="493.7"/>
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="740.8" y1="344.8" x2="890.8" y2="596.4"/>
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="801.2" y1="269.8" x2="1028.5" y2="426.2"/>
<g>
<g>
<path fill="#F2F2F2" d="M329.4,609.5c0,5.5-4.5,10-10,10H116c-5.5,0-10-4.5-10-10V503.7c0-5.5,4.5-10,10-10h203.4
c5.5,0,10,4.5,10,10V609.5z"/>
<path fill="none" stroke="#464747" stroke-width="22" stroke-miterlimit="10" d="M329.4,609.5c0,5.5-4.5,10-10,10H116
c-5.5,0-10-4.5-10-10V503.7c0-5.5,4.5-10,10-10h203.4c5.5,0,10,4.5,10,10V609.5z"/>
</g>
<rect x="124.7" y="523.8" fill="none" width="193.6" height="73.9"/>
<text transform="matrix(1 0 0 1 124.7476 533.7126)"><tspan x="0" y="0" font-family="'MyriadPro-Regular'" font-size="14">sample help text sample help </tspan><tspan x="0" y="16.8" font-family="'MyriadPro-Regular'" font-size="14">text sample help text sample </tspan><tspan x="0" y="33.6" font-family="'MyriadPro-Regular'" font-size="14">help text sample help text </tspan><tspan x="0" y="50.4" font-family="'MyriadPro-Regular'" font-size="14">sample help text sample help </tspan></text>
</g>
<radialGradient id="SVGID_1_" cx="329.75" cy="558.375" r="6.875" gradientUnits="userSpaceOnUse">
<stop offset="0" style="stop-color:#7A7A7A"/>
<stop offset="0.1457" style="stop-color:#767676"/>
<stop offset="0.3151" style="stop-color:#676767"/>
<stop offset="0.4963" style="stop-color:#505050"/>
<stop offset="0.6857" style="stop-color:#303030"/>
<stop offset="0.8799" style="stop-color:#060606"/>
<stop offset="0.9053" style="stop-color:#000000"/>
</radialGradient>
<circle fill="url(#SVGID_1_)" cx="329.8" cy="558.4" r="6.9"/>
<g>
<g>
<path fill="#050505" d="M590.2,815.3c-14.1-4.7-17.6-35.3-17.6-35.3c-0.6-5.5-4.4-9.9-8.4-10s-7.2,0-7.2-0.1c0,0-1,0-2.2,0
c-1.2,0-3.2,0-4.5,0c-1.2,0-2.3,0-2.3,0s-3.1,0-7,0.1c-3.8,0-7.5,4.5-8.1,10c0,0-3.4,30.6-17.4,35.3s-35.2,8.1-35.2,8.1
c-5.4,0.9-5.4,1.6,0.1,1.6H538c5.5,0,12,0,14.5,0s9,0,14.5,0h58.5c5.5,0,5.6-0.7,0.1-1.6C625.6,823.4,604.2,820,590.2,815.3z"/>
</g>
<g>
<path fill="#F2F2F2" d="M663,765.3c0,5.5-4.5,10-10,10H449.5c-5.5,0-10-4.5-10-10V622.1c0-5.5,4.5-10,10-10H653
c5.5,0,10,4.5,10,10V765.3z"/>
<path fill="none" stroke="#464747" stroke-width="5" stroke-miterlimit="10" d="M663,765.3c0,5.5-4.5,10-10,10H449.5
c-5.5,0-10-4.5-10-10V622.1c0-5.5,4.5-10,10-10H653c5.5,0,10,4.5,10,10V765.3z"/>
</g>
</g>
<rect x="461.5" y="630.6" fill="#CDF9F8" stroke="#565656" stroke-miterlimit="10" width="180.9" height="128"/>
<rect x="470.4" y="636.3" fill="none" width="172" height="121.2"/>
<text transform="matrix(1 0 0 1 470.4375 647.7349)"><tspan x="0" y="0" font-family="'ArialMT'" font-size="16">Getting Started </tspan><tspan x="0" y="19.2" font-family="'MyriadPro-Regular'" font-size="16">text sample help text </tspan><tspan x="0" y="38.4" font-family="'MyriadPro-Regular'" font-size="16">sample help text sample </tspan><tspan x="0" y="57.6" font-family="'MyriadPro-Regular'" font-size="16">help text sample help </tspan><tspan x="0" y="76.8" font-family="'MyriadPro-Regular'" font-size="16">text sample help text </tspan><tspan x="0" y="96" font-family="'MyriadPro-Regular'" font-size="16">sample help text sample </tspan></text>
<g>
<g>
<g>
<path fill="#050505" d="M976.4,778.4c-16.3-4.1-20.3-30.1-20.3-30.1c-0.8-5.4-5.3-9.9-9.9-9.9c-4.6,0-8.4,0-8.4-0.1
c0,0-1.2,0-2.6,0c-1.4,0-3.8,0-5.2,0c-1.5,0-2.6,0-2.6,0s-3.7,0-8.1,0.1c-4.5,0-8.8,4.5-9.5,9.9c0,0-3.7,26-20.1,30.1
c-16.3,4.1-42.5,7.4-42.5,7.4c-5.5,0.7-5.4,1.2,0.1,1.2h70.2c5.5,0,12.4,0,15.2,0c2.9,0,9.7,0,15.2,0h71.2
c5.5,0,5.5-0.5,0.1-1.2C1019.1,785.8,992.7,782.6,976.4,778.4z"/>
</g>
<g>
<path fill="#F2F2F2" d="M1061,733c0,5.5-4.5,10-10,10H811.2c-5.5,0-10-4.5-10-10V608.6c0-5.5,4.5-10,10-10H1051
c5.5,0,10,4.5,10,10V733z"/>
<path fill="none" stroke="#464747" stroke-width="5" stroke-miterlimit="10" d="M1061,733c0,5.5-4.5,10-10,10H811.2
c-5.5,0-10-4.5-10-10V608.6c0-5.5,4.5-10,10-10H1051c5.5,0,10,4.5,10,10V733z"/>
</g>
</g>
<rect x="811" y="606.8" fill="#F4E8C6" stroke="#565656" stroke-miterlimit="10" width="239.4" height="128"/>
<rect x="820.4" y="615.6" fill="none" width="220.6" height="110.5"/>
<text transform="matrix(1 0 0 1 820.4385 628.4581)"><tspan x="0" y="0" font-family="'ArialMT'" font-size="18">Learning Course</tspan><tspan x="0" y="21.6" font-family="'MyriadPro-Regular'" font-size="18">sample help text sample help </tspan><tspan x="0" y="43.2" font-family="'MyriadPro-Regular'" font-size="18">text sample help text sample </tspan><tspan x="0" y="64.8" font-family="'MyriadPro-Regular'" font-size="18">help text sample help text </tspan><tspan x="0" y="86.4" font-family="'MyriadPro-Regular'" font-size="18">sample help text sample help </tspan></text>
</g>
<g>
<path fill="#1E1E1E" d="M1080.8,544.5h-52.3c-4,0-7.2-3.2-7.2-7.2V433.4c0-4,3.2-7.2,7.2-7.2h52.3c4,0,7.2,3.2,7.2,7.2v103.8
C1088.1,541.2,1084.8,544.5,1080.8,544.5z"/>
<path fill="none" stroke="#565656" stroke-miterlimit="10" d="M1080.8,544.5h-52.3c-4,0-7.2-3.2-7.2-7.2V433.4
c0-4,3.2-7.2,7.2-7.2h52.3c4,0,7.2,3.2,7.2,7.2v103.8C1088.1,541.2,1084.8,544.5,1080.8,544.5z"/>
</g>
<path fill="#EAEAE8" stroke="#565656" stroke-miterlimit="10" d="M1081.5,525.8H1028c-0.8,0-1.5-0.7-1.5-1.5v-82.1
c0-0.8,0.7-1.5,1.5-1.5h53.5c0.8,0,1.5,0.7,1.5,1.5v82.1C1083,525.1,1082.3,525.8,1081.5,525.8z"/>
<radialGradient id="SVGID_2_" cx="1054.7556" cy="534.3206" r="5.6067" gradientUnits="userSpaceOnUse">
<stop offset="0" style="stop-color:#000000"/>
<stop offset="0.2375" style="stop-color:#030303"/>
<stop offset="0.4133" style="stop-color:#0C0C0C"/>
<stop offset="0.569" style="stop-color:#1C1C1C"/>
<stop offset="0.7133" style="stop-color:#333333"/>
<stop offset="0.8496" style="stop-color:#505050"/>
<stop offset="0.9782" style="stop-color:#747474"/>
<stop offset="1" style="stop-color:#7A7A7A"/>
</radialGradient>
<path fill="url(#SVGID_2_)" stroke="#565656" stroke-miterlimit="10" d="M1054.8,539.9L1054.8,539.9c-3.1,0-5.6-2.5-5.6-5.6l0,0
c0-3.1,2.5-5.6,5.6-5.6l0,0c3.1,0,5.6,2.5,5.6,5.6l0,0C1060.4,537.4,1057.8,539.9,1054.8,539.9z"/>
<rect x="1030.9" y="444" fill="none" width="52.3" height="76.1"/>
<text transform="matrix(1 0 0 1 1030.9103 449.4799)"><tspan x="0" y="0" font-family="'MyriadPro-Regular'" font-size="7.6892">sample help </tspan><tspan x="0" y="9.2" font-family="'MyriadPro-Regular'" font-size="7.6892">text sample </tspan><tspan x="0" y="18.5" font-family="'MyriadPro-Regular'" font-size="7.6892">help text </tspan><tspan x="0" y="27.7" font-family="'MyriadPro-Regular'" font-size="7.6892">sample help </tspan><tspan x="0" y="36.9" font-family="'MyriadPro-Regular'" font-size="7.6892">text sample </tspan><tspan x="0" y="46.1" font-family="'MyriadPro-Regular'" font-size="7.6892">help text </tspan><tspan x="0" y="55.4" font-family="'MyriadPro-Regular'" font-size="7.6892">sample help </tspan><tspan x="0" y="64.6" font-family="'MyriadPro-Regular'" font-size="7.6892">text sample </tspan></text>
<g>
<image overflow="visible" opacity="0.75" width="518" height="361" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgYAAAFpCAYAAADndeCyAAAACXBIWXMAAAsSAAALEgHS3X78AAAA
GXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAASs5JREFUeNrsnQl328gOZkFK8pK8
7vn/P3M6i21tnJfzxGkYBlCg9uXec3gky07iiJLq8isUSgQAAAAAAAAAwNLxFADwXnUYeMoB+LAB
gNt6Px7r/Tuc+OcBADEAgAPed92RHt93gJ/6OMIAgBgAwBHeZ13jsS752W6Pf2+YMKgPhfuHigQA
@ -425,11 +425,11 @@ dtwIASAGAHBznzmtGgRPEGZOojBLZGBm/o5TLlesJgebIEmIDisCrRoChAAQAwC4+fQgSxE6Z3Dv
g+TTAttAMFrJAEIAiAEAPJwgdA1ZyG6zhkbH3ithKIhCNPBXkgGEABADAHjYz6Noq+SuIQxdIR3I
koLKXglZcnDoIZL3IEAIADEAAFKERBKkKACVmoKumBZkciCNQT5LA4YknQBADACAz6iCMOx7e8jn
4NAQhJY0tP4MQgCIAQDAHp9X3cT7rc+9qYnBVFmoJAHIACAGAABH/Pw6lghMTQ1a3xv2FA4AxAAA
4ISfZ6f43BtO9LMAiAEAwJ18xiEAAAAAAAAAAABwJ/w/AQYAuGFQ+UyZzQYAAAAASUVORK5CYII=" transform="matrix(1 0 0 1 391 57)">
</image>
<g>
<image overflow="visible" opacity="0.75" width="490" height="335" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeoAAAFPCAYAAACCvI1nAAAACXBIWXMAAAsSAAALEgHS3X78AAAA
4ISfZ6f43BtO9LMAiAEAwJ18xiEAAAAAAAAAAABwJ/w/AQYAuGFQ+UyZzQYAAAAASUVORK5CYII=" transform="matrix(1 0 0 1 391 57)">
</image>
<g>
<image overflow="visible" opacity="0.75" width="490" height="335" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeoAAAFPCAYAAACCvI1nAAAACXBIWXMAAAsSAAALEgHS3X78AAAA
GXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAABB39JREFUeNrsvd2SJMW17+nL3SMi
P7u6gGqQTIw0sr2xOWD7Shdzc8y2HuDc8grzGsBrnFfgdh6gt9nYmJ0LXW2DY8aWybYGHQko6Oqi
KiszI8J9zX8t94iMrK6GBgGiu90h2yO/IiOzIvzn/+Xrw5jSSiuttNJKK6200korrbTSSivtuzcq
@ -1614,48 +1614,48 @@ e2deni8FPn6wFOgpQEEyPqHVYushwrt3MNp+hG/e/AjDHRLzpIqf5dvaB68AeGBYn5xFzoKIWhCE
/1M9hEu/LZI2v67FfbSl4DnAQt7xg98CcB/3nWd9BjA9Pl45NtzdRTi8+yIWSZnhtAxRyn1ivinm
eH0iZ0FELQiCJG24Je4YueN7f6t8wcvrtcujg+X+5/ec/dVytRcxs7/0+0sS8t5i65aYRc6CiFoQ
BOGuegrv1OJi1961yP8c35GI1W/WkCJmQUQtCILwB+st/LWx/3JNqD7XGQVBEARBEARBEARBEIR/
lF8EGABklz789jrEhQAAAABJRU5ErkJggg==" transform="matrix(1 0 0 1 405 70)">
</image>
<g>
<path fill="#F0F1F2" d="M872.2,193.7c0-33.9-36.1-61.5-80.6-61.5c-14.4,0-27.9,2.9-39.6,7.9c1.7-3.4,2.6-7.2,2.6-11.1
c0-16-15.2-28.9-34-28.9c-9.1,0-17.3,3-23.4,8C681,90,657.8,78.6,632.1,78.6c-23.7,0-45.3,9.7-61.3,25.5
c-10.6-3.9-22.2-6-34.4-6c-48,0-86.8,32.9-86.8,73.4c0,7.8,1.4,15.3,4.1,22.4c-24.5,12-40.3,31.1-40.3,52.7
c0,19.4,12.9,36.9,33.3,48.9c-6.4,6.6-10.1,14.5-10.1,23c0,23.3,28,42.2,62.6,42.2c20.3,0,38.4-6.5,49.8-16.6
c15.8,11.5,35.7,18.4,57.3,18.4c20.7,0,39.7-6.3,55.2-16.9c3.3,21.1,24.6,37.4,50.4,37.4c25.7,0,46.9-16.1,50.4-37
c49.6-6.5,87-35,87-69.3c0-11.6-4.3-22.6-12-32.3C858.4,233.3,872.2,214.7,872.2,193.7z"/>
</g>
</g>
</g>
<rect x="525.6" y="205.9" fill="none" width="234.4" height="96.9"/>
<text transform="matrix(1 0 0 1 525.5938 241.437)" font-family="'MyriadPro-Regular'" font-size="50">Help API</text>
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="585.2" y1="360.2" x2="554.8" y2="605.7"/>
<path id="SVGID_x5F_3_x5F_" fill="none" d="M271,410.2l134.7-113.7"/>
<text> <textPath xlink:href="#SVGID_x5F_3_x5F_" startOffset="18.213%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<path id="SVGID_x5F_4_x5F_" fill="none" d="M554.1,542.3l23-175"/>
<text> <textPath xlink:href="#SVGID_x5F_4_x5F_" startOffset="0.22%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<path id="SVGID_x5F_5_x5F_" fill="none" d="M870.3,307.5l144.5,101.4"/>
<text> <textPath xlink:href="#SVGID_x5F_5_x5F_" startOffset="0.22%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<path id="SVGID_x5F_6_x5F_" fill="none" d="M781.2,394.3l88.7,152.6"/>
<text> <textPath xlink:href="#SVGID_x5F_6_x5F_" startOffset="0.22%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<polygon points="263.5,398.9 270.5,405.9 277.6,412.9 268,415.5 258.4,418.1 261,408.5 "/>
<polygon points="556.4,557.7 550.2,565.5 543.9,573.2 540.4,563.9 536.8,554.6 546.6,556.2 "/>
<polygon points="864.2,506.2 864.1,516.2 864,526.1 855.4,521 846.9,515.9 855.5,511.1 "/>
<polygon points="979.7,389.2 985.5,381.1 991.2,373 995.3,382 999.5,391 989.6,390.1 "/>
<rect x="149.7" y="645.1" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 149.7164 663.7129)" font-family="'ArialMT'" font-size="26">website #1</text>
<rect x="488.4" y="837.1" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 488.429 855.7129)" font-family="'ArialMT'" font-size="26">website #2</text>
<rect x="982.4" y="556.7" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 982.4254 575.2835)" font-family="'ArialMT'" font-size="26">website #4</text>
<rect x="868.7" y="804.1" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 868.7164 822.7129)" font-family="'ArialMT'" font-size="26">website #3</text>
</g>
</svg>
lF8EGABklz789jrEhQAAAABJRU5ErkJggg==" transform="matrix(1 0 0 1 405 70)">
</image>
<g>
<path fill="#F0F1F2" d="M872.2,193.7c0-33.9-36.1-61.5-80.6-61.5c-14.4,0-27.9,2.9-39.6,7.9c1.7-3.4,2.6-7.2,2.6-11.1
c0-16-15.2-28.9-34-28.9c-9.1,0-17.3,3-23.4,8C681,90,657.8,78.6,632.1,78.6c-23.7,0-45.3,9.7-61.3,25.5
c-10.6-3.9-22.2-6-34.4-6c-48,0-86.8,32.9-86.8,73.4c0,7.8,1.4,15.3,4.1,22.4c-24.5,12-40.3,31.1-40.3,52.7
c0,19.4,12.9,36.9,33.3,48.9c-6.4,6.6-10.1,14.5-10.1,23c0,23.3,28,42.2,62.6,42.2c20.3,0,38.4-6.5,49.8-16.6
c15.8,11.5,35.7,18.4,57.3,18.4c20.7,0,39.7-6.3,55.2-16.9c3.3,21.1,24.6,37.4,50.4,37.4c25.7,0,46.9-16.1,50.4-37
c49.6-6.5,87-35,87-69.3c0-11.6-4.3-22.6-12-32.3C858.4,233.3,872.2,214.7,872.2,193.7z"/>
</g>
</g>
</g>
<rect x="525.6" y="205.9" fill="none" width="234.4" height="96.9"/>
<text transform="matrix(1 0 0 1 525.5938 241.437)" font-family="'MyriadPro-Regular'" font-size="50">Help API</text>
<line fill="none" stroke="#5E5E5D" stroke-width="3" stroke-miterlimit="10" x1="585.2" y1="360.2" x2="554.8" y2="605.7"/>
<path id="SVGID_x5F_3_x5F_" fill="none" d="M271,410.2l134.7-113.7"/>
<text> <textPath xlink:href="#SVGID_x5F_3_x5F_" startOffset="18.213%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<path id="SVGID_x5F_4_x5F_" fill="none" d="M554.1,542.3l23-175"/>
<text> <textPath xlink:href="#SVGID_x5F_4_x5F_" startOffset="0.22%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<path id="SVGID_x5F_5_x5F_" fill="none" d="M870.3,307.5l144.5,101.4"/>
<text> <textPath xlink:href="#SVGID_x5F_5_x5F_" startOffset="0.22%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<path id="SVGID_x5F_6_x5F_" fill="none" d="M781.2,394.3l88.7,152.6"/>
<text> <textPath xlink:href="#SVGID_x5F_6_x5F_" startOffset="0.22%">
<tspan font-family="'ArialMT'" font-size="18">pulling from API</tspan> </textPath>
</text>
<polygon points="263.5,398.9 270.5,405.9 277.6,412.9 268,415.5 258.4,418.1 261,408.5 "/>
<polygon points="556.4,557.7 550.2,565.5 543.9,573.2 540.4,563.9 536.8,554.6 546.6,556.2 "/>
<polygon points="864.2,506.2 864.1,516.2 864,526.1 855.4,521 846.9,515.9 855.5,511.1 "/>
<polygon points="979.7,389.2 985.5,381.1 991.2,373 995.3,382 999.5,391 989.6,390.1 "/>
<rect x="149.7" y="645.1" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 149.7164 663.7129)" font-family="'ArialMT'" font-size="26">website #1</text>
<rect x="488.4" y="837.1" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 488.429 855.7129)" font-family="'ArialMT'" font-size="26">website #2</text>
<rect x="982.4" y="556.7" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 982.4254 575.2835)" font-family="'ArialMT'" font-size="26">website #4</text>
<rect x="868.7" y="804.1" fill="none" width="136" height="33"/>
<text transform="matrix(1 0 0 1 868.7164 822.7129)" font-family="'ArialMT'" font-size="26">website #3</text>
</g>
</svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 126 KiB

0
mydoc/images/illustratoroptions.png → images/illustratoroptions.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 115 KiB

0
mydoc/images/itermexample.png → images/itermexample.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 67 KiB

0
mydoc/images/jekyll.png → images/jekyll.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.2 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

0
mydoc/images/killalljekyll.png → images/killalljekyll.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

76
index.html
View File

@ -1,20 +1,66 @@
---
layout: none
search: exclude
title: Introduction
tags: [getting_started]
sidebar: home_sidebar
toc: none
---
{% include custom/conditions.html %}
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="0;url={{projectFolder}}/home.html">
<script type="text/javascript">
window.location.href = "{{projectFolder}}/home.html"
</script>
</head>
<body>
<div class="container">
<!-- Marketing Icons Section -->
<div class="row">
<div class="col-lg-12">
<h2 class="page-header">
Welcome to Modern Business
</h2>
</div>
<div class="col-md-4">
<div class="panel panel-default">
<div class="panel-heading">
<h4><i class="fa fa-fw fa-check"></i> Mydoc</h4>
</div>
<div class="panel-body">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Itaque, optio corporis quae nulla aspernatur in alias at numquam rerum ea excepturi expedita tenetur assumenda voluptatibus eveniet incidunt dicta nostrum quod?</p>
<a href="{{ "/mydoc_landing_page/" | prepend: site.baseurl }}" class="btn btn-default">Learn More</a>
</div>
</div>
</div>
<div class="col-md-4">
<div class="panel panel-default">
<div class="panel-heading">
<h4><i class="fa fa-fw fa-gift"></i> Product 1</h4>
</div>
<div class="panel-body">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Itaque, optio corporis quae nulla aspernatur in alias at numquam rerum ea excepturi expedita tenetur assumenda voluptatibus eveniet incidunt dicta nostrum quod?</p>
<a href="{{ "/p1_landing_page/" | prepend: site.baseurl }}" class="btn btn-default">Learn More</a>
</div>
</div>
</div>
<div class="col-md-4">
<div class="panel panel-default">
<div class="panel-heading">
<h4><i class="fa fa-fw fa-compass"></i> Product 2</h4>
</div>
<div class="panel-body">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Itaque, optio corporis quae nulla aspernatur in alias at numquam rerum ea excepturi expedita tenetur assumenda voluptatibus eveniet incidunt dicta nostrum quod?</p>
<a href="{{ "/p2_landing_page" | prepend: site.baseurl }}" class="btn btn-default">Learn More</a>
</div>
</div>
</div>
</div>
<!-- /.row -->
<!-- Call to Action Section -->
<div class="well">
<div class="row">
<div class="col-md-8">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Molestias, expedita, saepe, vero rerum deleniti beatae veniam harum neque nemo praesentium cum alias asperiores commodi.</p>
</div>
<div class="col-md-4">
<a class="btn btn-lg btn-default btn-block" href="https://github.com/tomjohnson1492/documentation-theme-jekyll">Download the source</a>
</div>
</div>
</div>
</body>
</html>

9
js/jquery.ba-throttle-debounce.min.js vendored
View File

@ -1,9 +0,0 @@
/*
* jQuery throttle / debounce - v1.1 - 3/7/2010
* http://benalman.com/projects/jquery-throttle-debounce-plugin/
*
* Copyright (c) 2010 "Cowboy" Ben Alman
* Dual licensed under the MIT and GPL licenses.
* http://benalman.com/about/license/
*/
(function(b,c){var $=b.jQuery||b.Cowboy||(b.Cowboy={}),a;$.throttle=a=function(e,f,j,i){var h,d=0;if(typeof f!=="boolean"){i=j;j=f;f=c}function g(){var o=this,m=+new Date()-d,n=arguments;function l(){d=+new Date();j.apply(o,n)}function k(){h=c}if(i&&!h){l()}h&&clearTimeout(h);if(i===c&&m>e){l()}else{if(f!==true){h=setTimeout(i?k:l,i===c?e-m:e)}}}if($.guid){g.guid=j.guid=j.guid||$.guid++}return g};$.debounce=function(d,e,f){return f===c?a(d,e,false):a(d,f,e!==false)}})(this);

7
js/jquery.localScroll.min.js vendored
View File

@ -1,7 +0,0 @@
/**
* Copyright (c) 2007-2014 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
* Licensed under MIT
* @author Ariel Flesler
* @version 1.3.5
*/
;(function(a){if(typeof define==='function'&&define.amd){define(['jquery'],a)}else{a(jQuery)}}(function($){var g=location.href.replace(/#.*/,'');var h=$.localScroll=function(a){$('body').localScroll(a)};h.defaults={duration:1000,axis:'y',event:'click',stop:true,target:window};$.fn.localScroll=function(a){a=$.extend({},h.defaults,a);if(a.hash&&location.hash){if(a.target)window.scrollTo(0,0);scroll(0,location,a)}return a.lazy?this.on(a.event,'a,area',function(e){if(filter.call(this)){scroll(e,this,a)}}):this.find('a,area').filter(filter).bind(a.event,function(e){scroll(e,this,a)}).end().end();function filter(){return!!this.href&&!!this.hash&&this.href.replace(this.hash,'')==g&&(!a.filter||$(this).is(a.filter))}};h.hash=function(){};function scroll(e,a,b){var c=a.hash.slice(1),elem=document.getElementById(c)||document.getElementsByName(c)[0];if(!elem)return;if(e)e.preventDefault();var d=$(b.target);if(b.lock&&d.is(':animated')||b.onBefore&&b.onBefore(e,elem,d)===false)return;if(b.stop)d._scrollable().stop(true);if(b.hash){var f=elem.id===c?'id':'name',$a=$('<a> </a>').attr(f,c).css({position:'absolute',top:$(window).scrollTop(),left:$(window).scrollLeft()});elem[f]='';$('body').prepend($a);location.hash=a.hash;$a.remove();elem[f]=c}d.scrollTo(elem,b).trigger('notify.serialScroll',[elem])};return h}));

7
js/jquery.scrollTo.min.js vendored
View File

@ -1,7 +0,0 @@
/**
* Copyright (c) 2007-2014 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
* Licensed under MIT
* @author Ariel Flesler
* @version 1.4.14
*/
;(function(k){'use strict';k(['jquery'],function($){var j=$.scrollTo=function(a,b,c){return $(window).scrollTo(a,b,c)};j.defaults={axis:'xy',duration:0,limit:!0};j.window=function(a){return $(window)._scrollable()};$.fn._scrollable=function(){return this.map(function(){var a=this,isWin=!a.nodeName||$.inArray(a.nodeName.toLowerCase(),['iframe','#document','html','body'])!=-1;if(!isWin)return a;var b=(a.contentWindow||a).document||a.ownerDocument||a;return/webkit/i.test(navigator.userAgent)||b.compatMode=='BackCompat'?b.body:b.documentElement})};$.fn.scrollTo=function(f,g,h){if(typeof g=='object'){h=g;g=0}if(typeof h=='function')h={onAfter:h};if(f=='max')f=9e9;h=$.extend({},j.defaults,h);g=g||h.duration;h.queue=h.queue&&h.axis.length>1;if(h.queue)g/=2;h.offset=both(h.offset);h.over=both(h.over);return this._scrollable().each(function(){if(f==null)return;var d=this,$elem=$(d),targ=f,toff,attr={},win=$elem.is('html,body');switch(typeof targ){case'number':case'string':if(/^([+-]=?)?\d+(\.\d+)?(px|%)?$/.test(targ)){targ=both(targ);break}targ=win?$(targ):$(targ,this);if(!targ.length)return;case'object':if(targ.is||targ.style)toff=(targ=$(targ)).offset()}var e=$.isFunction(h.offset)&&h.offset(d,targ)||h.offset;$.each(h.axis.split(''),function(i,a){var b=a=='x'?'Left':'Top',pos=b.toLowerCase(),key='scroll'+b,old=d[key],max=j.max(d,a);if(toff){attr[key]=toff[pos]+(win?0:old-$elem.offset()[pos]);if(h.margin){attr[key]-=parseInt(targ.css('margin'+b))||0;attr[key]-=parseInt(targ.css('border'+b+'Width'))||0}attr[key]+=e[pos]||0;if(h.over[pos])attr[key]+=targ[a=='x'?'width':'height']()*h.over[pos]}else{var c=targ[pos];attr[key]=c.slice&&c.slice(-1)=='%'?parseFloat(c)/100*max:c}if(h.limit&&/^\d+$/.test(attr[key]))attr[key]=attr[key]<=0?0:Math.min(attr[key],max);if(!i&&h.queue){if(old!=attr[key])animate(h.onAfterFirst);delete attr[key]}});animate(h.onAfter);function animate(a){$elem.animate(attr,g,h.easing,a&&function(){a.call(this,targ,h)})}}).end()};j.max=function(a,b){var c=b=='x'?'Width':'Height',scroll='scroll'+c;if(!$(a).is('html,body'))return a[scroll]-$(a)[c.toLowerCase()]();var d='client'+c,html=a.ownerDocument.documentElement,body=a.ownerDocument.body;return Math.max(html[scroll],body[scroll])-Math.min(html[d],body[d])};function both(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}return j})}(typeof define==='function'&&define.amd?define:function(a,b){if(typeof module!=='undefined'&&module.exports){module.exports=b(require('jquery'))}else{b(jQuery)}}));

1588
js/jquery.shuffle.min.js vendored
View File

File diff suppressed because it is too large Load Diff

16
licenses/LICENSE-BSD-NAVGOCO.txt
View File

@ -4,14 +4,14 @@ All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the <Christodoulos Tsoulloftas> nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the <Christodoulos Tsoulloftas> nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

15766
mydoc/files/mydoc_designers_pdf.pdf
View File

File diff suppressed because it is too large Load Diff

15822
mydoc/files/mydoc_writers_pdf.pdf
View File

File diff suppressed because it is too large Load Diff

49
mydoc/home.md
View File

@ -1,49 +0,0 @@
---
title: Introduction
tags: [getting_started]
audience: field engineers, clients
type: first_page
homepage: true
---
## Overview
This site provides documentation, training, and other notes for the Jekyll Documentation theme. There's a lot of information about how to do a variety of things here, and it's not all unique to this theme. But by and large, understanding how to do things in Jekyll depends on how your theme is coded. As a result, these additional details are provided.
The instructions here are geared towards technical writers working on documentation. You may have a team of one or more technical writers working on documentation for multiple projects. You can use this same theme to author all of your documentation for each of your products. The theme is set up to push out documentation for multiple projects all from the same source. You can also share content across projects.
## Survey of features
Some of the more prominent features of this theme include the following:
* Bootstrap framework
* Sidebar for table of contents
* Top navigation bar with drop-down menus
* PDF generation (through Prince XML utility)
* Build scripts to automate the workflow
* Notes, tips, and warning information notes
* A nifty system for creating links to different pages
* Tags for alternative nativation
* Content sharing across projects
* Emphasis on pages, not posts
* Relative (rather than absolute) link structure, so you can push the outputs anywhere and easily view them
I'm using this theme for my documentation projects, building about 20 different outputs for various products, versions, languages, and audiences from the same set of files. This single sourcing requirement has influenced how I constructed this theme.
For more discussion about the available features, see {{site.data.mydoc.mydoc_urls.mydoc_supported_features.link}}.
## Getting started
To get started, see these three topics:
1. {{site.data.mydoc.mydoc_urls.mydoc_getting_started.link}}
2. {{site.data.mydoc.mydoc_urls.mydoc_configuration_settings.link}}
3. {{site.data.mydoc.mydoc_urls.mydoc_adding_new_projects.link}}
## PDF Download Option for Help Material
If you would like to download this help file as a PDF, you can do so here. The PDF is comprehensive of all the content in the online help.
<a target="_blank" class="noCrossRef" href="files/{{site.pdf_file_name}}"><button type="button" class="btn btn-default" aria-label="Left Align"><span class="glyphicon glyphicon-download-alt" aria-hidden="true"></span> PDF Download</button></a>
The PDF contains a timestamp in the header indicating when it was last generated.

8
mydoc/mydoc_about.md
View File

@ -1,14 +1,16 @@
---
title: About the theme author
keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements
last_updated: November 30, 2015
last_updated: March 20, 2016
tags: [getting_started]
summary: "I use this theme for sophisticated single_sourcing projects that I work on as a professional technical writer."
summary: "I have used this theme for projects that I've worked on as a professional technical writer."
sidebar: mydoc_sidebar
permalink: /mydoc_about/
---
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.
I'm using this theme for my documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free.
I have used this theme and variations of it for various documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free.
I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. But it's completely empowering as well!

76
mydoc/mydoc_adding_new_projects.md
View File

@ -1,76 +0,0 @@
---
title: 2. Add a new project
tags: [getting_started]
last_updated: November 30, 2015
keywords: getting started, customization, beginning steps, modifying the theme, modification
summary: "You add a new project essentially by duplicating all the mydoc project files in the _data, _includes, configs, and other folders. You can add as many projects as you want in this theme."
series: "Getting Started"
weight: 2
---
{% include custom/mydoc/getting_started_series.html %}
## About customizing the theme
The theme shows two build outputs: one for designers, and one for writers. The dual outputs is an example of the single sourcing nature of the theme. The designers output is comprehensive, whereas the writers output is a subset of the information. However, the outputs are mostly the same. I just created the separate output to demonstrate how the single sourcing aspect works.
You can add as many documentation projects as you want to the same Jekyll project. Some doc projects have multiple outputs, as is the case with the designers and writers outputs for the mydoc project.
## Add a new project
Follow these steps to add additional projects.
{{site.data.alerts.important}} In these instructions, I'll assume your project's name is "acme." Replace "acme" with the real name of your project. {{site.data.alerts.end}}
### 1. Copy and customize the mydoc folder in _data
Inside the \_data folder, copy the mydoc folder and its contents. Rename it to acme, and then rename each of the YML files inside the folder with the acme prefix.
The files in data control how the side and top nav bar get populated. Here is also where URLs, definitions, and other settings are stored.
### 2. Copy and customize the mydoc folder in configs
In the configs folder, copy the mydoc folder and its contents. Rename it to acme, and then rename each of the config_ files to the outputs you need for your acme project.
In this theme, each output requires a separate config file. If you have 10 audiences and you want separate sites for each, then then you'll have 10 config files in this directory.
Change the file names from config_writers.yml and so forth to whatever file names best represent the audiences for your outputs.
More details about customizing the settings in the configuration files will be explained later. For now you're just duplicating the necessary project files for your new project.
### 3. Create a new folder inside \_includes/custom
In the _includes/custom directory, add a new folder there called "acme." This folder should sit parallel to the mydoc folder. This is where you can store includes for your project.
### 4. Add a new folder in the root directory
In the root directory, add a folder for your pages called acme (similar to the mydoc folder). Include two subfolders inside acme: files and images.
Inside the mydoc folder, copy the home.md file and add it to the acme folder. (With most Jekyll projects, they open up on the index.html file in the root directory. However, because the pages for each project are stored in subfolders, it was necessary to create a redirect from the index page to the home.md page.)
This acme directory is where you'll store all your pages.
Note that you cannot create subfolders in this acme directory. All of your pages have to be flat in this directory. This is because the references to the resources (stylesheets, javascript, etc.) are relative, and creating additional directory levels will break the relative paths.
### 5. Copy and customize the mydoc shell scripts in the root directory
In the root directory, duplicate the shell scripts (the file extension is .sh) and rename the prefix to "acme_". The following files are the shell scripts that need to be duplicated:
* mydoc_1_multiserve_pdf.sh
* mydoc_2_multibuild_pdf.sh
* mydoc_3_multibuild_web.sh
* mydoc_4_publish.sh
* mydoc_all.sh
### 6. Copy the URL generator text file
In the root directory, copy urls_mydoc.txt and duplicate it. Change the suffix to urls_acme.txt.
{{site.data.alerts.tip}} In this step, you're just duplicating project files. In later steps, you'll actually customize all of the settings. {{site.data.alerts.end}}
{% include custom/mydoc/getting_started_series_next.html %}

6
mydoc/mydoc_adding_tooltips.md
View File

@ -2,8 +2,10 @@
title: Tooltips
tags: [formatting]
keywords: popovers, tooltips, user interface text, glossaries, definitions
last_updated: November 30, 2015
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/
---
## Creating tooltips
@ -19,4 +21,4 @@ Suppose you have a glossary.yml file inside your \_data folder. You could pull i
This renders to the following:
<a href="#" data-toggle="tooltip" data-original-title="{{site.data.glossary.jekyll_platform}}">Jekyll</a> is my favorite tool for building websites.</a>
<a href="#" data-toggle="tooltip" data-original-title="{{site.data.glossary.jekyll_platform}}">Jekyll</a> is my favorite tool for building websites.

9
mydoc/mydoc_alerts.md
View File

@ -2,10 +2,11 @@
title: Alerts
tags: [formatting]
keywords: notes, tips, cautions, warnings, admonitions
last_updated: November 30, 2015
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes are stored as shortcodes made available through the linksrefs.hmtl include."
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/
---
{% comment %} comment 4 by saphira {% endcomment %}
## About alerts
Alerts are little warnings, info, or other messages that you have called out in special formatting. In order to use these alerts or callouts, just reference the appropriate value stored in the alerts.yml file as described in the following sections.
@ -80,5 +81,5 @@ If you want to blast a warning to users on every page, add the alert or callout
## Using Markdown inside of notes
You can't use Markdown formatting inside alerts. This is because the alerts leverage HTML, and you can't use Markdown inside of HTML tags.
You can't use Markdown formatting inside alerts. This is because the alerts leverage HTML, and you can't use Markdown inside of HTML tags. It's very easy to forget this, which is why I recommend using HTML formatting for links in every case. This way you're less likely to forget to switch into HTML mode when you're writing content in a tip. You must remember, however, to avoid Markdown with code and bold formatting inside of notes.

10
mydoc/mydoc_algoliasearch.md
View File

@ -1,10 +0,0 @@
---
title: Algolia search
tags: [formatting]
keywords: search
summary: "This page demonstrates an integration of Algolia search."
---
## algolia:
{% include algolia.html %}

22
mydoc/mydoc_build_arguments.md
View File

@ -2,8 +2,10 @@
title: Build arguments
tags: [publishing]
keywords: building, serving, serve, build
last_updated: November 30, 2015
summary: "When you have a single sourcing project, you use more advanced arguments when you're building or serving your Jekyll sites. These arguments specify a particular configuration file and may build on other configuration files."
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/
---
## How to build Jekyll sites
@ -23,16 +25,20 @@ jekyll serve
By default, the _config.yml in the root directory will be used, Jekyll will scan the current directory for files, and the folder `_site` will be used as the output. You can customize these build commands like this:
```
jekyll serve --config configs/config_writers.yml --destination /users/tjohnson/projects/documentation-theme-jekyll-builds/writer
jekyll serve --config configs/myspecialconfig.yml --destination ../doc_outputs
```
Here the `configs/config_writers.yml` file is used instead of `_config.yml`. The destination directory is `../mydoc_writers`.
Here the `configs/myspecialconfig.yml` file is used instead of `_config.yml`. The destination directory is `../doc_outputs`, which would be one level up from your current directory.
## Shortcuts for the build arguments
If you don't want to enter the long Jekyll argument every time, with all your configuration details, you can create a shell script and then just run the script. This theme shows an example with the mydoc_multibuild_web.sh file in the root directory.
If you have a long build argument and don't want to enter it every time in Jekyll, noting all your configuration details, you can create a shell script and then just run the script. Simply put the build argument into a text file and save it with the .sh extension (for Mac) or .bat extension (for Windows). Then run it like this:
My preference is to add the scripts to profiles in iTerm. See {{site.data.mydoc.mydoc_urls.mydoc_iterm_profiles.link}} for more details.
```
. myscript.sh
```
My preference is to add the scripts to profiles in iTerm. See {{site.data.urls.mydoc_iterm_profiles.link}} for more details.
## Stop a server
@ -54,9 +60,9 @@ To kill all Jekyll instances, use this:
kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}')
```
I created a profile in iTerm that stores this command. Here's what the iTerm settings look like:
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)
![iTerm profile settings to kill all Jekyll]({{ "/images/killalljekyll.png" | prepend: site.baseurl }})

30
mydoc/mydoc_build_scripts.md
View File

@ -3,13 +3,15 @@ title: 10. Configure the build scripts
tags:
- publishing
keywords: "build scripts, generating outputs, building, publishing"
last_updated: "November 30, 2015"
last_updated: "November 30, 2016"
summary: "You need to customize the build scripts. These script automate the publishing of your PDFs and web outputs through shell scripts on the command line."
series: "Getting Started"
weight: 10
sidebar: mydoc_sidebar
permalink: /mydoc_build_scripts/
---
{% include custom/mydoc/getting_started_series.html %}
{% include custom/getting_started_series.html %}
## About the build scripts
@ -23,16 +25,16 @@ To set up your projects:
1. Set up your Jekyll theme in a folder called "docs." All of the source files for every project the team is working on should live in this directory. Most likely you already either downloaded or cloned the jekyll-documentation-theme. Just rename the folder to "docs" and move it into the projects folder as shown here.
2. In the same root directory where the docs folder is, create another directory parallel to docs called doc_outputs. 
Thus, your folder structure should be something like this:
```
projects
- docs
- doc_outputs
```
The docs folder contains the source of all your files, while the doc_outputs contains the site outputs.
Thus, your folder structure should be something like this:
```
projects
- docs
- doc_outputs
```
The docs folder contains the source of all your files, while the doc_outputs contains the site outputs.
## Configure the Build Scripts
@ -148,7 +150,7 @@ This script first removes the project folder on /var/www/html/yourpublishingdire
Note that the delete part of the script (`rm -rf`) works really well. It annihilates a folder in a heartbeat and doesn't give you any warning prompts, so make sure you have it set up correctly.
Also, in case you haven't set up the SSH publishing without a password, see {{site.data.mydoc.mydoc_no_password_prompts_scp.link}}. Otherwise the script will stop and ping you to enter your password for each directory it transfers.
Also, in case you haven't set up the SSH publishing without a password, see {{site.data.mydoc_no_password_prompts_scp.link}}. Otherwise the script will stop and ping you to enter your password for each directory it transfers.
### (Optional) Push to repositories
@ -188,4 +190,4 @@ After you've configured all the scripts, you can run them all by running `. mydo
## Test out the scripts
After setting up and customizing the build scripts, run a few tests to make sure everything is generating correctly. Getting this part right is somewhat difficult and may likely require you to tinker around with the scripts a while before it works flawlessly.
{% include custom/mydoc/getting_started_series_next.html %}
{% include custom/getting_started_series_next.html %}

13
mydoc/mydoc_collections.md
View File

@ -2,13 +2,14 @@
title: Collections
tags: [content-types]
keywords: groups, api, structure
last_updated: November 30, 2015
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/
---
## What are collections
Collections are custom content types different from pages and posts. You might create a collection if you want to treat a specific set of articles in a unique way, such as with a custom layout or listing. For more detail on collections, see [Ben Balter's explanation of collections here](http://ben.balter.com/2015/02/20/jekyll-collections/).
Collections are custom content types different from pages and posts. You might create a collection if you want to treat a specific set of articles in a unique way, such as with a custom layout or listing. For more detail on collections, see [Ben Balter's explanation of collections here](http://ben.balter.com/2016/02/20/jekyll-collections/).
## Create a collection
To create a collection, add the following in your configuration file:
@ -29,4 +30,8 @@ See [Collections in the Jekyll documentation](http://jekyllrb.com/docs/collectio
## How to use collections
I haven't found a huge use for collections in normal documentation. However, I did find a use for collections in generating a tooltip file that would be used for delivering tooltips to a user interface from text files in the documentation. See {{site.data.mydoc.mydoc_urls.mydoc_help_api.link}} for details.
I haven't found a huge use for collections in normal documentation. However, I did find a use for collections in generating a tooltip file that would be used for delivering tooltips to a user interface from text files in the documentation. See {{site.data.mydoc_urls.mydoc_help_api.link}} for details.
## Video tutorial on collections
See this [video tutorial on Jekyll.tips](http://jekyll.tips/jekyll-casts/introduction-to-collections/) for more details on collections.

49
mydoc/mydoc_commenting_on_files.md
View File

@ -3,9 +3,10 @@ title: Commenting on files
tags:
- navigation
keywords: "annotations, comments, feedback"
last_updated: "November 30, 2015"
summary: "You can add a button to your pages that allows people to add comments. Prose.io is an overlay on Github that would allow people to make comments in an easier interface."
published: true
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/
---
## About the review process
@ -18,32 +19,29 @@ Here's the code for that button on the page.html layout:
{% raw %}
```
{% if site.github_editme_path %}
<a href="https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}" class="btn btn-default " role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
{% endif %}
{% 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 %}
```
{% endraw %}
You could also make it so the Github button appears only when you're working in a development environment.
This code is only active if you're publishing in a development environment, which is the default.
To activate the production environment, add the [production environment flag](http://jekyllrb.com/docs/configuration/) in your build command:
{% raw %}
```
{% if jekyll.environment == "development" %}
{% if site.github_editme_path %}
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
{% endif %}
JEKYLL_ENV=production jekyll serve
```
{% endraw %}
To activate the development environment, add the [environment flag](http://jekyllrb.com/docs/configuration/) in your build command:
In your configuration file, edit the value for `github_editme_path`. For example, you might create a branch called "reviews" on your Github repo. Then you would add something like this in your configuration file for the 'github_editme_path': tomjohnson1492/documentation-theme-jekyll/edit/reviews. Here "tomjohnson1492" is my github account name. The repo name is "documentation-theme-jekyll". The "reviews" name is the branch.
{% raw %}
```
JEKYLL_ENV=development jekyll serve
```
{% endraw %}
The default environment is production.
## Add reviewers as collaborators
@ -54,3 +52,16 @@ If you don't want to allow anyone to commit to your Github branch, don't add the
{{site.data.alerts.note}} When you process pull requests, you have to accept everything or nothing. You can't pick and choose which changes you'll merge. Therefore you'll probably want to edit the branch you're planning to merge or ask the contributor to make some changes to the fork before processing the pull request.{{site.data.alerts.end}}
## Workflow
Users will make edits in your "reviews" branch (or whatever you want to call it). You can then commit those edits as you make updates.
When you're finished making all updates in the branch, you can merge the branch into the master.
Note that if you're making updates online, those updates will be out of sync with any local edits.
{{site.data.alerts.warning}} Don't make edits both online using Github's browser-based interface AND offline on your local machine using your local tools. When you try to push from your local, you'll likely get a merge conflict error. Instead, make sure you do a pull and update on your local after making any edits online.{{site.data.alerts.end}}
## Prose.io
Prose.io is an overlay on Github that would allow people to make comments in an easier interface. If you simply go to [prose.io](http://prose.io), it asks to authorize your Github account, and so it will read files directly from Github but in the Prose.io interface.

93
mydoc/mydoc_conditional_logic.md
View File

@ -2,55 +2,45 @@
title: Conditional logic
tags: [single_sourcing]
keywords: if else logic, conditions, conditional attributes, conditional filtering
last_updated: November 30, 2015
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/
---
## About Liquid and conditional statements
If you want to create different outputs for different audiences, you can do all of this using a combination of Jekyll's Liquid markup and values in your configuration file.
If you want to create different outputs for different audiences, you can do all of this using a combination of Jekyll's Liquid markup and values in your configuration file. This is how I previously configured the theme. I had different configuration files for each output. Each configuration file specified different values for product, audience, version, and so on. Then I had different build processes that would leverage the different configuration files. It seemed like a perfect implementation of DITA-like techniques with Jekyll.
You can then incorporate conditional statements that check the values in the configuration files.
But I soon found that having lots of separate outputs for a project was undesirable. If you have 10 different outputs that have different nuances for different audiences, it's hard to manage and maintain. In this latest version of the theme, I consolidated all information into the same output to explicitly do away with the multi-output approach.
As such, the conditional logic won't have as much play as it previously did. Instead of conditions, you'll probably want to incorporate [navtabs](mydoc_navtabs) to split up the information.
However, you can still of course use conditional logic as needed.
{{site.data.alerts.tip}} Definitely check out <a href="http://docs.shopify.com/themes/liquid-documentation/basics">Liquid's documentation</a> for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site.{{site.data.alerts.end}}
## Where to store filtering values
You can filter content based on values that you have set either in your config file or in a file in your \_data folder. If you set the attribute in your config file, you need to restart the Jekyll server to see the changes. If you set the value in a file in your \_data folder, you don't need to restart the server when you make changes.
## Required conditional attributes
This theme requires you to add the following attributes in your configuration file:
* project
* audience
* product
* platform
* version
If you've ever used DITA, you probably recognize these attributes, since DITA has mostly the same ones. I've found that most single_sourcing projects I work on can be sliced and diced in the ways I need using these conditional attributes.
If you're not single sourcing and you find it annoying having to specify these attributes in your sidebar, you can rip out the logic from the sidebar.html, topnav.html file and any other places where conditions.html appears; then you wouldn't need these attributes in your configuration file.
You can filter content based on values that you have set either in your page's frontmatter, a config file, or in a file in your \_data folder. If you set the attribute in your config file, you need to restart the Jekyll server to see the changes. If you set the value in a file in your \_data folder or page frontmatter, you don't need to restart the server when you make changes.
## Conditional logic based on config file value
Here's an example of conditional logic based on a value in the configs/config_writer.yml file. In my config_writer.yml file, I have the following:
Here's an example of conditional logic based on a value in the page's frontmatter. Suppose you have the following in your frontmatter:
```
audience: writers
platform: mac
```
On a page in my site (it can be HTML or markdown), I can conditionalize content using the following:
On a page in my site (it can be HTML or markdown), you can conditionalize content using the following:
{% raw %}
```liquid
{% if site.audience == "writers" %}
The writer audience should see this...
{% elsif site.audience == "designers" %}
The designer audience should see this ...
{% if page.platform == "mac" %}
Here's some info about the Mac.
{% elsif page.platform == "windows" %}
Here's some info about Windows ...
{% endif %}
```
{% endraw %}
This uses simple `if-elsif` logic to determine what is shown (note the spelling of `elsif`). The `else` statement handles all other conditions not handled by the `if` statements.
@ -62,9 +52,9 @@ Here's an example of `if-else` logic inside a list:
To bake a casserole:
1. Gather the ingredients.
{% if site.audience == "writer" %}
{% if page.audience == "writer" %}
2. Add in a pound of meat.
{% elsif site.audience == "designer" %}
{% elsif page.audience == "designer" %}
3. Add in an extra can of beans.
{% endif %}
3. Bake in oven for 45 min.
@ -81,8 +71,8 @@ For example, here's an example using `or`:
{% raw %}
```liquid
{% if site.audience contains "vegan" or site.audience == "vegetarian" %}
// run this.
{% if page.audience contains "vegan" or page.audience == "vegetarian" %}
Then run this...
{% endif %}
```
{% endraw %}
@ -91,7 +81,7 @@ Note that you have to specify the full condition each time. You can't shorten th
{% raw %}
```liquid
{% if site.audience contains "vegan" or "vegetarian" %}
{% if page.audience contains "vegan" or "vegetarian" %}
// run this.
{% endif %}
```
@ -106,16 +96,14 @@ You can also use `unless` in your logic, like this:
{% raw %}
```liquid
{% unless site.output == "pdf" %}
...
...do this
{% endunless %}
```
{% endraw %}
When figuring out this logic, read it like this: "Run the code here *unless* this condition is satisfied." Or "If this condition is satisfied, don't run this code."
When figuring out this logic, read it like this: "Run the code here *unless* this condition is satisfied."."
Don't read it the other way around or you'll get confused. (It's not executing the code only if the condition is satisfied.)
In this situation, if `site.print == true`, then the code will *not* be run here.
Don't read it the other way around or you'll get confused. (It's *not* executing the code only if the condition is satisfied.)
## Storing conditions in the \_data folder
@ -135,12 +123,6 @@ this shows if neither of the above two if conditions are met.
To use this, I would need to have a \_data folder called options where the `output` property is stored.
I don't really use the \_data folder as much for project options. I store them in the configuration file because I usually want different projects to use different values for the same property.
For example, maybe a file or function name is called something different for different audiences. I currently single source the same content to at least two audiences in different markets.
For the first audience, the function name might be called `generate`, but for the second audience, the same function might be called called `expand`. In my content, I'd just use {% raw %}`{{site.function}}`{% endraw %}. Then in the configuration file I change its value appropriately for the audience.
## Specifying the location for \_data
You can also specify a `data_source` for your data location in your configuration file. Then you aren't limited to simply using `_data` to store your data files.
@ -150,7 +132,7 @@ For example, suppose you have 2 projects: alpha and beta. You might store all th
In your alpha configuration file, specify the data source like this:
```
data_source: data_alpha
data_source: data_amydoc_content_reuselpha
```
Then create a folder called \_data_alpha.
@ -164,29 +146,6 @@ data_source: data_beta
Then create a folder called \_data_beta.
## Conditional logic based on page namespace
You can also create conditional logic based on the page namespace. For example, create a page with front matter as follows:
{% raw %}
```liquid
---
layout: page
user_plan: full
---
```
{% endraw %}
Now you can run logic based on the conditional property in that page's front matter:
{% raw %}
```liquid
{% if page.user_plan == "full" %}
// run this code
{% endif %}
```
{% endraw %}
## Conditions versus includes
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.

49
mydoc/mydoc_conditions_file_customization.md
View File

@ -1,49 +0,0 @@
---
title: 5. Customize the conditions file
tags:
- navigation
keywords: "single sourcing, conditions, filtering, attributes, logic"
last_updated: "November 30, 2015"
summary: "The conditions file is included in various parts of the theme. Its purpose is to set attributes as variables that affect how the theme is constructed. The settings in this file are essential for single sourcing."
series: "Getting Started"
weight: 7
---
{% include custom/mydoc/getting_started_series.html %}
## About the conditions.html file
The conditions file is a critical file that sets certain variables used in constructing the theme. You already set some of these values in the configuration file, but you need to duplicate some of the settings here. In this file, the settings are variable assignments.
This file is used as include in certain files. When used as an include, it sets variables that are used to configure your theme. Because you're single sourcing your Jekyll content, you need this file.
## Customize the conditions file
In the \_includes/custom directory, open the conditions.html file. Duplicate one of the project settings blocks like this:
{% raw %}
```
{% if site.project == "mydoc_writers" %}
{% assign audience = "writers" %}
{% assign sidebar = site.data.mydoc.mydoc_sidebar.entries %}
{% assign topnav = site.data.mydoc.mydoc_topnav.topnav %}
{% assign topnav_dropdowns = site.data.mydoc.mydoc_topnav.topnav_dropdowns %}
{% assign version = "all" %}
{% assign product = "all" %}
{% assign platform = "all" %}
{% assign projectTags = site.data.mydoc.mydoc_tags.allowed-tags %}
{% assign projectFolder = "mydoc" %}
{% endif %}
```
{% endraw %}
You need to duplicate this block for each output you have.
Once you've duplicated the block, make a few customizations:
* In each place that "mydoc" appears, change "mydoc" to "acme".
* Use the same attributes for project, audience, version, product, and platform that you used in your configuration file. (If you don't have a specific attribute value that you need, just put "all".) The values here have to exactly match those in the configuration file.
{{site.data.alerts.tip}} If you want to create signposts in the code as shown in the conditions.html file, install a utility called [figlets](http://www.figlet.org/) on your Mac. The figlets just make scanning long code blocks easier. If you have 15+ configuration groupings in your conditions file, the figlets make it easy to scan.{{site.data.alerts.end}}
{% include custom/mydoc/getting_started_series_next.html %}

115
mydoc/mydoc_configuration_settings.md
View File

@ -1,115 +0,0 @@
---
title: 4. Set the configuration options
tags: [single_sourcing, publishing]
keywords: configuration, config, publishing options, outputs, projects
last_updated: November 30, 2015
summary: "The configuration file contains important settings for your project. Some of the values you set here affect the display and functionality of the theme &mdash; especially the product, platform, audience, and version."
series: "Getting Started"
weight: 4
---
{% include custom/mydoc/getting_started_series.html %}
## Importance of the configuration file
The configuration file serves important functions with single sourcing. For each site output, you create a unique configuration file for that output.
The configuration file contains most of the settings and other details unique to that site output, such as variables, titles, output directories, build folders, and more.
## Change the project name within the config file
By default, the config file contains the project name, such as mydoc, in numerous places. You can do a find and replace in each of the configuration files to replace "mydoc" with your new project's name. You can also fine tune the configuration settings by looking at what each of them does (as described in the following sections).
## Update the exclude list
By default, all the files in the Jekyll project are included in the output. You have two manually tell Jekyll which files and folders you want to exclude from the output. In each configuration file there is an `exclude` property that takes a list of items that should be excluded from the build.
In the new configuration file that you created, exclude the mydoc folder and any other mydoc files that you don't want to be output. Similarly, update the mydoc configuration files to exclude the new project that you added.
Manually excluding files from the output is one of pain points in Jekyll that I could never solve. Jekyll was not designed for multiple output publishing but was conceived as a way to manage files for a single website.
## Configuration file variables
You can define arbitrary key-value pairs in the configuration file, and then you can access them through `site.yourkey`, where `yourkey` is the name of the key.
However, some of the options you set in the configuration file determine theme settings. These options are required for this theme to work. The required settings are defined in the following tables.
## Configuration settings for web outputs
The values in the following tables are used to control different aspects of the theme and are not arbitrary key-value pairs. As you set up your project, enter the appropriate values for each of these keys in the configuration file.
If you're unsure how or where the project setting affects the theme, just search for the project setting in the theme (for example, `site.sidebar_version`) and you'll see the files involved.
The order of the settings doesn't matter.
| Field | Required? | Description |
|-------|-----------|-----------|
| **project** | Required| A unique name for the project. The \_includes/custom/conditions.html file will use this project name to determine what sidebar and top nav data files to use. Make this value unique. Note that the project name also determines what conditions are set in the conditions.html file. It's critical that the project name you specify in the configuration file matches the project names in the conditions.html file. Otherwise, the conditions.html file won't be able to set the right variables needed for single sourcing. (Admittedly, the settings for these attributes are somewhat duplicated between the conditions.html and configuration file.)|
| **audience** | Required | The audience for the output. This value is also set in the \_includes/custom/conditions.html file. Each entry in \_data/sidebar_doc.yml and \_data/topnav_doc.yml needs to have an audience attribute that matches the correct audience value in order for the sidebar or topnav item to be included.|
| **platform** | Required | The platform for the output. The same matching logic applies as with audience.
| **product** | Required | The product for the output. The same matching logic applies as with audience.
| **version** | Required | The version for the output. The same matching logic applies as with audience.
| **destination** | Required | The folder where the site is built. If you put this into your same folder as your other files, Jekyll may start building and rebuilding in an infinite loop because it detects more files in the project folder. Make sure you specify a folder outside your project folder, by using `../` or by specifying the absolute path. The recommended output folder is `../doc_outputs`. The PDF configuration files will look in that directory for the outputs needed to build the PDF outputs.|
| **sidebar_tagline** | Optional | Appears above the sidebar. Usually you put some term related to the site specific build, such as the audience name. In the sample theme files, the taglines are "writers" and "designers." Keep these short &mdash; there's not much room. Six or seven letters is perfect.|
| **sidebar_version** | Optional | Appears below the sidebar_tagline in a smaller font, usually specifying the version of the documentation. In the sample theme files, the version is "4.0."|
| **topnav_title** | Required | Appears next to the home icon in the top nav bar. In the sample theme files, the topnav_title is "Jekyll Documentation Theme." |
| **homepage_title**| Required | You set the title for your homepage via this setting. This is because multiple projects are all using the same index.md as their homepage. Because index.md has `homepage: true` in the frontmatter, the "page" layout will use the `homepage_title` property from the configuration file instead of the traditional title in the frontmatter. In the sample theme files, the homepage title is "Jekyll Documentation Theme &mdash; writers" or "Jekyll Documentation Theme &mdash; designers." |
| **site_title**| Required | Appears in the webpage title area (on the browser tab, not in the page viewing area). In the sample theme files, the site title is rendered as {% raw %}`{{ page.title }}{% endif %} | {{ site.site_title }}`{% endraw %} (these values get dynamically replaced depending on the page name and title). |
| **port** | Required | The port used in the preview mode. This is only for the live preview and doesn't affect the published output. If you serve multiple outputs simultaneously, the port must be unique. |
| **feedback_email** | Required | Gets configured as the email address in the Send Feedback button in the top navigation bar.|
| **disqus_shortname** | Optional | The Disqus site shortname, which is used for comments. If you don't want comment forms via disqus, leave this blank or omit it altogether and Disqus won't appear. |
| **markdown** | Required | The processor used to convert Markdown to HTML. This is a Jekyll-specific setting. Use `redcarpet`. Another option is `kramdown`. However, my examples will follow redcarpet. |
| **redcarpet** | Required | Extensions used with redcarpet. You can read more about the Red Carpet extensions [here](https://github.com/vmg/redcarpet). |
| **highlighter** | Required | The syntax highlighter used. Use `rouge` because it has fewer dependencies on your operating system (it doesn't require Python). However, you can also use `pygments`. If so, you may need need to [install Pygments](http://pygments.org/download/). |
| **exclude** | Optional | A list of files and directories that you want excluded from the build. By default, all the content in your project is included in the output. If you don't want to include a file or directory, list it here. It's helpful to name your files with a prefix such as product_audience_filename.md, so that you can exclude using wildcards such as "product*" or product_audience*". For more information about excluding files, see {{site.data.mydoc.mydoc_urls.mydoc_excluding_files.link}}. |
| **defaults** | Optional | Here you can set default values for frontmatter based on the content type (page, post, or collection). |
| **collections** | Optional | Any specific collections (custom content types that extend beyond pages or posts) that you want to define. This theme defines a collection called tooltips. You access this collection by using site.tooltips instead of site.pages or site.posts. Put the tooltip content types inside a folder in your project called \_tooltips. Tooltips are useful for creating UI content. For more information about creating tooltips for UI text, see {{site.data.mydoc.mydoc_urls.mydoc_help_api.link}}. |
| **output** | Optional | Boolean. Whether this build is `web` or `pdf`. This setting allows you to run conditions in your content such as {% raw %} `{% if site.output == pdf %}` do this... `{% endif %}` {% endraw %}. Limit the options to just `web` or `pdf` for this setting. |
| **github_editme_path** | Optional | A path to configure the Github Edit Me button. Put the path to the branch on Github where you want to edit the theme. Here's a sample: `tomjohnson1492/documentation-theme-jekyll/edit/reviews`. In this case, "reviews" is the name of the branch where I want people to make edits. I can then merge the "reviews" branch with the "gh-pages" branch (which is the default branch). See the "page" layout (inside the \_layouts folder) for how this path gets inserted into the rest of the HTML.|
| **company_name** | Optional | Used in the footer to brand your site.|
| **footer_image_location** | Optional | The image used in the footer to brand your site. Store this image in the common_images folder so that it's not excluded by a particular project. Example: ../common_images/company_logo.png|
| **theme_file** | Optional | The theme used for the output. Currently there are two options: theme-green.css or theme-blue.css. These themes cover both web and PDF output. The themes have the same style and layout. They only differ in the accent color for the top nav bar, buttons, hyperlinks, and other small details. |
| **pdf_file_name** | Optional | The name of the PDF file generated by Prince. This is helpful for the code on the home.md page that allows users to download a PDF of the material. If you have 5 different PDFs, you don't want to use `if` statements to render different PDF buttons. Instead, this theme uses the same PDF code but swaps out the PDF file name with a variable here. |
## Where to store configuration files
In this theme, all the configuration files are listed in the configs directory. There are some build scripts in the root directory that reference the configuration files in this configs folder.
There's also a \_config.yml file in the root directory. This is simply copied from the configs directory and used to accommodate publishing with Github Pages.
## Configuration settings for PDF output
The PDF configuration files build on all the settings in the web configuration files, but they add a few more options.
When you build the PDF output (such as for the writers output), the command will look like this:
```
jekyll serve --detach --config configs/config_writers.yml,configs/config_writers_pdf.yml
```
First Jekyll will read the config_writers.yml file, and then Jekyll will read the config_writers_pdf.yml file. Values from both configuration files will be used, but the later configuration file (on the right) will overwrite any values set in the previous configuration file (on the left).
(Previously people running Windows reported problems with cascading the configuration files like this. If you're on Windows, for PDF outputs, you may need to combine the settings from the web configuration file into the PDF configuration file.)
More detail about generating PDFs is provided in {{site.data.mydoc.mydoc_urls.mydoc_generating_pdfs.link}}, but the configuration settings used for the PDFs are described here.
The process for creating PDFs relies on two steps:
1. First you build a printer-friendly web version of the content.
2. Then you run PrinceXML to get all the printer-friendly web pages and package them into a PDF.
Thus, you actually build a web version for the PDF first before generating the PDF.
The following table describes the settings in the PDF configuration file.
| Field | Required? | Description |
|-------|-----------|-----------|
| **destination** | Where the PDF web version should be served so that Prince XML can find it. By default, this is in `../mydoc_designers-pdf`, which is just one level above where your project is. |
| **url** | The URL where the files can be viewed. This is `http://127.0.0.1:4002` in the sample theme files for the designers output. Prince XML requires a URL to access the file. |
| **baseurl** | The subdirectory after the url where the content is stored. In the sample theme files for the designers output, this is `/designers`. |
| **port** | The port required by the preview server. |
| **output** | `web` or `pdf`. This setting allows you to construct conditional statements in your content to check whether output is web or pdf. This setting can help you filter out content that doesn't fit well into a PDF (such as dynamic web elements). In particular, the Prince XML script conflicts with any JavaScript on the page, so you want to filter out the JavaScript from the PDF-friendly HTML output that Prince consumes.|
| **print_title** | The title for the PDF. In the sample theme files for designers output, the print title is "Jekyll Documentation Theme for Designers"|
| **print_subtitle** | The subtitle for the PDF. In the sample theme files, the subtitle is "version 4.0." |
| **defaults** | See the sample settings in the config_designers_pdf.yml file. The only difference between this file and config_designers.yml is that the layout used for pages is `page_print` instead of `page`. The `page_print` layout also used `head_print` instead of `head`. This layout strips out components such as the sidebar and top navigation. It also leverages printstyles.css and includes some JavaScript for Prince XML. |
{% include custom/mydoc/getting_started_series_next.html %}

146
mydoc/mydoc_configure_sidebar.md
View File

@ -1,146 +0,0 @@
---
title: 6. Configure the sidebar
tags: [getting_started]
last_updated: November 30, 2015
keywords: sidebar, accordion, yaml, iteration, for loop, navigation, attributes, conditional filtering
summary: "The sidebar and top navigation bar read their values from yml files. The navigation components are one of the most unique parts of this theme, since the navigation components are only included if they meet all of the product, audience, version, etc., values as specified in the project settings. Understanding how the sidebar works is critical to successfully using this theme."
series: "Getting Started"
weight: 6
---
{% include custom/mydoc/getting_started_series.html %}
## Understand how the sidebar works
In the \_data folder, the mydoc_sidebar.yml files contains the sidebar items for the theme. These list items (which are in YAML format) form your main navigation, and all pages in your project must appear here to be included in the PDF or the URL generator. Both the PDF and the URL generator (mydoc_urls.txt) iterate over the pages listed in the mydoc_sidebar.yml file to produce their output.
As a best practice, do the following with the sidebar:
* List all pages in your project somewhere in the sidebar.
* As soon as you create a new page, add it to your sidebar (so you don't forget about the page).
* Copy and paste the existing YAML chunks (then customize them) to get the formatting right.
YAML is a markup that uses spacing and hyphens instead of tags. YAML is a superset of JSON, so you can convert from YAML to JSON and vice versa equivalently.
There are certain values in the sidebar file coded to match the theme's code. These values include the main level names (`entries`, `subcategories`, `items`, `thirdlevel`, and `thirdlevelitems`). If you change these values in the sidebar file, the navigation won't display. (As long as you follow the sample with mydoc_sidebar.yml, you should be fine.)
At a high level, the sidebar data structure looks like this:
```yaml
entries
subcategories
items
thirdlevel
thirdlevelitems
```
Within these levels, you add your content. You can only have two levels in the sidebar. Here's an example:
```
Introduction
-> Getting started
-> Features
-> Configuration
-> Options
-> Automation
```
"Introduction" is a heading &mdash; it's the first level. Beneath it are Getting started and Features &mdash; these sub-items for the first level.
Configuration is a heading announcing a second level. Below it are Options and Automation &mdash; these are on the second level.
You can't add more than two levels. In general, it's a best practice not to create more than two levels of navigation anyway, since it creates a paralysis of choice for the user.
(If you need deeper sublevels, I recommend creating different sidebars for different pages, which is logic that I haven't coded into the theme but which could probably be added fairly easily. Additionally, if you wanted to create a third level, you could do so by following the same pattern as the second level and customizing a few things. However, the theme is not coded to support additional levels.)
The code in the theme's sidebar.html file (in the \_includes folder) iterates through the items in the mydoc_sidebar.yml file using a Liquid `for` loop and inserts the items into HTML. Iterating over a list in a data file to populate HTML is a common technique with static site generators.
What I've added in this theme is some special logic that checks if the sidebar items meet the right attribute conditions. As a result, the sidebar.html file has code that looks like this:
{% raw %}
```liquid
{% include custom/conditions.html %}
{% for entry in sidebar %}
{% for subcategory in entry.subcategories %}
{% if subcategory.audience contains audience and subcategory.product contains product and subcategory.platform contains platform and subcategory.version contains version and subcategory.output contains "web" %}
```
{% endraw %}
Only if the sidebar item contains the right `audience`, `product`, `platform`, `version`, and `output` attributes does the item get included in the sidebar navigation.
This means you will have just one sidebar data file for all the outputs in a single project. Different projects will use different sidebar data files, but all outputs for a single project will use the same sidebar data file. (This allows you to do single sourcing.)
If you look at the code above, you'll see that `audience`, `product`, `platform`, and `version` are defined generally. In sidebar.html, there are lines like `subcategory.audience contains audience`.
This is where the conditions.html file (inside \_includes) comes into play. `audience` is a variable defined in the conditions.html file. If you open up conditions.html, you'll see something like this:
{% raw %}
```liquid
{% if site.project == "mydoc_writers" %}
{% assign audience = "writers" %}
{% assign sidebar = site.data.mydoc.mydoc_sidebar.entries %}
{% assign topnav = site.data.mydoc.mydoc_topnav.topnav %}
{% assign topnav_dropdowns = site.data.mydoc.mydoc_topnav.topnav_dropdowns %}
{% assign version = "all" %}
{% assign product = "all" %}
{% assign platform = "all" %}
{% assign projectTags = site.data.mydoc.mydoc_tags.allowed-tags %}
{% assign projectFolder = "mydoc" %}
{% endif %}
```
{% endraw %}
`audience` is a variable set to `writers` for the mydoc_writers project. Therefore anywhere `audience` appears, `writers` gets inserted in its place.
When the sidebar.html code runs `subcategory.audience contains audience`, it's saying that the subcategory item must have an attribute called `audience`, and the value for audience must contain `writers`.
All of the attributes (which are defined in the conditions.html file) must be met in order to display in the navigation. The attributes must be present on both the heading and items under that heading.
However, note that the `output` attribute is a bit different. With this attribute, you just list whether you want a `web` or `pdf` output (or both, usually). For both, you just write `web, pdf`.
The logic in the sidebar is multi-step and somewhat complex, but you're also doing something truly sophisticated. You're instructing a static site generator to conditionally include certain information while using the same source files (not just the same sidebar data file, but the same sidebar.html file).
Fortunately, once you set it up, you don't need to think about the underlying logic that's processing. You just make sure you're putting the right attributes on your sidebar items.
## Recognize the frontmatter in the sidebar
The first section in the sidebar subcategory list is a special frontmatter section that you should pretty much leave alone (except for changing the attribute values). It looks like this:
```yaml
- title:
audience: writers, designers
platform: all
product: all
version: all
output: pdf
type: frontmatter
items:
- title:
url: /titlepage.html
audience: writers, designers
platform: all
product: all
version: all
output: pdf
type: frontmatter
- title:
url: /tocpage.html
audience: writers, designers
platform: all
product: all
version: all
output: pdf
type: frontmatter
```
The only values you should change here are the values for the `audience`, `platform`, `product,` and `version`.
These frontmatter pages are used in producing the PDF. This part will grab the titlepage.html and tocpage.html content in the theme's root directory. (If you're not publishing PDF, you can remove this section.)
Note that the output is `pdf` only for these frontmatter pages. They are specific to the PDF output only.
To learn more about the sidebar, see {{site.data.mydoc.mydoc_urls.mydoc_sidebar_navigation.link}}.
{% include custom/mydoc/getting_started_series_next.html %}

19
mydoc/mydoc_content_reuse.md
View File

@ -2,30 +2,24 @@
title: Content reuse
tags: [single_sourcing]
keywords: includes, conref, dita, transclusion, transclude, inclusion, reference
last_updated: November 30, 2015
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/
---
## About content reuse
You can embed content from one file inside another using includes. Put the file containing content you want to reuse (e.g., mypage.html) inside the \_includes/mydoc folder (replacing "mydoc" with your project's name), 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/custom folder and then use a tag like this:
{% raw %}
```
{% include mydoc/mypage.html %}
{% include custom/mypage.html %}
```
{% endraw %}
With content in your \_includes folder, you don't add any frontmatter to these pages because they will be included on other pages already containing frontmatter.
Also, when you include a file, all of the file's contents get included. You can't specify that you only want a specific part of the file included. However, you can use parameters with includes. See [Jekyll's documentation](http://stackoverflow.com/questions/21976330/passing-parameters-to-inclusion-in-liquid-templates) for more information on that.
## Re-using content across projects
When you want to re-use a topic across projects, store the content in the \includes folder (it can be in any project's subfolder). Any folder that begins with an underscore (`_`) isn't included in the site output.
Also be sure to put any images in the common_images folder. None of the assets in the common_images folder should be excluded in the configuration files. This means every project's output will include the resources from the common_images folder.
However, each project will likely exclude content from the specific folders where the pages are stored. This is why reuse across projects requires you to use the \_includes folder and the common_images folder. (Unfortunately you can't include an image from the \_includes folder.)
Also, when you include a file, all of the file's contents get included. You can't specify that you only want a specific part of the file included. However, you can use parameters with includes. See [Jekyll's documentation](http://stackoverflow.com/questions/21976330/passing-parameters-to-inclusion-in-liquid-templates) for more information.
## Page-level variables
@ -51,7 +45,6 @@ thing2: {{page.thing2}}
```
{% endraw %}
I haven't found a use case for page-level variables, but it's nice to know they're available.
I use includes all the time. Most of the includes in the \_includes directory are pulled into the theme layouts. For those includes that change, I put them inside custom and then inside a specific project folder.

29
mydoc/mydoc_decide_on_attributes.md
View File

@ -1,29 +0,0 @@
---
title: 3. Decide on your project's attributes
tags: [getting_started]
last_updated: November 30, 2015
keywords: attributes, conditional filtering, audience, platform, product, version, output, DITA, variables
summary: "Each project has attributes that define the audience, platform, product, version, and output. These attributes are used in generating the outputs. The attributes function as filtering conditions that determine what content gets included in the navigation."
series: "Getting Started"
weight: 3
---
{% include custom/mydoc/getting_started_series.html %}
## Your attribute values
Before you can customize your project's settings, you have to make some decisions about the following:
* `audience`
* `platform`
* `product`
* `version`
* `output` (web, pdf)
Every project uses a value for these settings, so even if the attribute doesn't apply to your project, you will need to put some value for `audience`, `platform`, `product`, and `version` (a value such as `all` will work fine).
The `audience`, `platform`, `product`, and `version` settings derive from the same filtering attributes as in DITA. You can usually create any kind of filtered output by combining these attributes in different ways.
For example, you might have different product lines (lite versus pro), different versions (1.0 versus 2.0), different platforms (such as Java versus C++), and different audiences (administrators versus analysts) and so on. You'll need to know the values you want to use for each attribute in order to configure the project successfully to build the different outputs.
If you aren't sure of your outputs, just put `all` for the `audience`, `platform`, `product`, and `version`. For the `output` value, the options are fixed to either `web` or `pdf` (or both &mdash; `web, pdf` &mdash; separated by a comma).
{% include custom/mydoc/getting_started_series_next.html %}

Some files were not shown because too many files have changed in this diff Show More