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

updates for 6.0 release start here. see the release notes for all the details in 6.0

Browse Source
This commit is contained in:
tomjohnson1492 2016-07-04 23:41:16 -07:00
parent a468f26a3f
commit 2b60b63e25
140 changed files with 11559 additions and 12124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
404.md
View File

@ -3,4 +3,4 @@ title: "Page Not Found"
search: exclude
---
Sorry, but the page you were trying to view does not exist — perhaps you can try searching for it.
Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

47
_config.yml
View File

@ -1,39 +1,47 @@
permalink: /:year/:month/:day/:title/
# this sets the style for permalinks. The date formatting (/:year/:month/:day/) will only apply to blog posts, while the pages will just show the title.
url: http://idratherbewriting.com
# where you plan to publish your site
baseurl: "/documentation-theme-jekyll"
# any subdirectory that appears after the domain where you're publishing your site
include: ['_pages']
# this tag includes all pages from the pages directory and puts them into the root directory
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
topnav_title: Jekyll Documentation Theme
# this appears on the top navigation bar next to the home button
site_title: Jekyll theme for designers
site_title: Jekyll theme for documentation
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
company_name: Your company
# this appears in the footer
github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages
github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages/_pages/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
disqus_shortname: idrbwjekyll
# if you're using disqus for comments, add the shortname here. if not, leave this value blank.
host: 127.0.0.1
# the preview server used. Leave as is.
port: 4005
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts.
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
exclude:
- _site
- _drafts/
- .idea/
- .gitignore
# these are the files and directories that jekyll will exclude from the build
feedback_email: tomjohnson1492@gmail.com
# used as a contact email for the Feedback link in the top navigation bar
#feedback_disable: true
#feedback_text: "Need help?"
#feedback_link: "http://helpy.io/"
# change feedback link behaviour if you use a support ticketing system or something else
# feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed
# feedback_text: "Need help?"
# if you uncomment the previous line, it changes the Feedback text
# feedback_link: "http://helpy.io/"
# if you uncomment the previous line, it changes where the feedback link points to
highlighter: rouge
# library used for syntax highlighting
@ -49,7 +57,7 @@ kramdown:
collections:
tooltips:
output: false
# collection declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output.
# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true
defaults:
-
@ -79,10 +87,15 @@ defaults:
layout: "post"
comments: true
search: true
sidebar: tags_sidebar
sidebar: home_sidebar
# these are defaults used for the frontmatter for these file types
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
# the description is used in the feed.xml file

589
_data/mydoc_urls.yml
View File

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

21
_data/otherlinks.yml Normal file
View File

@ -0,0 +1,21 @@
# Follow the pattern here for the URLs -- no slash at the beginning, and include the .html. The link here is rendered exactly as is in the Markdown references.
entries:
- title: other
folders:
- title: Other Links
folderitems:
- title: Automated links bookmark
exact_url: mydoc_hyperlinks.html#automatedlinks
ref: mydoc_hyperlinks-automatedlinks
- title: Bookmark links
exact_url: mydoc_hyperlinks.html#bookmarklinks
ref: mydoc_hyperlinks-bookmarklinks
- title: Some link bookmark
exact_url: mydoc_pages.html#someIdTag
ref: someIdTag

13
_data/sidebars/home_sidebar.yml
View File

@ -8,20 +8,15 @@ entries:
- title: Products
output: web
folderitems:
- title: Home
url: /
output: web
type: homepage
- title: News
url: /news/
url: /news
output: web
- title: Theme instructions
url: /mydoc_introduction/
url: /mydoc_introduction
output: web
- title: Product 1
url: /p1_landing_page/
url: /p1_landing_page
output: web
- title: Product 2
url: /p2_landing_page/
url: /p2_landing_page
output: web

163
_data/sidebars/mydoc_sidebar.yml
View File

@ -3,7 +3,7 @@
entries:
- title: sidebar
product: Jekyll Doc Theme
version: 5.0
version: 6.0
folders:
- title:
@ -11,11 +11,11 @@ entries:
type: frontmatter
folderitems:
- title:
url: /titlepage/
url: /titlepage
output: pdf
type: frontmatter
- title:
url: /tocpage/
url: /tocpage
output: pdf
type: frontmatter
@ -24,32 +24,35 @@ entries:
folderitems:
- title: Get started
url: /
type: homepage
output: web, pdf
- title: 5.0 Release notes
url: /mydoc_release_notes_50/
output: web, pdf
- title: Sample page
url: /samplepage/
url: /index
output: web, pdf
- title: Introduction
url: /mydoc_introduction/
url: /mydoc_introduction
output: web, pdf
- title: Supported features
url: /mydoc_supported_features/
url: /mydoc_supported_features
output: web, pdf
- title: About the theme author
url: /mydoc_about/
url: /mydoc_about
output: web, pdf
- title: Support
url: /mydoc_support/
url: /mydoc_support
output: web, pdf
- title: Release Notes
output: web, pdf
folderitems:
- title: 6.0 Release notes
url: /mydoc_release_notes_60
output: web, pdf
- title: 5.0 Release notes
url: /mydoc_release_notes_50
output: web, pdf
- title: Installation
@ -57,184 +60,200 @@ entries:
folderitems:
- title: About Ruby, Gems, Bundler, etc.
url: /mydoc_about_ruby_gems_etc/
url: /mydoc_about_ruby_gems_etc
output: web, pdf
- title: Install Jekyll on Mac
url: /mydoc_install_jekyll_on_mac/
url: /mydoc_install_jekyll_on_mac
output: web, pdf
- title: Install Jekyll on Windows
url: /mydoc_install_jekyll_on_windows/
url: /mydoc_install_jekyll_on_windows
output: web, pdf
- title: Authoring
output: web, pdf
folderitems:
- title: Pages
url: /mydoc_pages/
url: /mydoc_pages
output: web, pdf
- title: Posts
url: /mydoc_posts/
url: /mydoc_posts
output: web, pdf
- title: WebStorm Text Editor
url: /mydoc_webstorm_text_editor/
- title: Lists
url: /mydoc_lists
output: web, pdf
- title: Conditional logic
url: /mydoc_conditional_logic/
url: /mydoc_conditional_logic
output: web, pdf
- title: Content reuse
url: /mydoc_content_reuse/
url: /mydoc_content_reuse
output: web, pdf
- title: Collections
url: /mydoc_collections/
url: /mydoc_collections
output: web, pdf
- title: WebStorm editor tips
url: /mydoc_webstorm_text_editor
output: web, pdf
- title: Atom editor tips
url: /mydoc_atom_text_editor
output: web, pdf
- title: Navigation
output: web, pdf
folderitems:
- title: Sidebar navigation
url: /mydoc_sidebar_navigation/
url: /mydoc_sidebar_navigation
output: web, pdf
- title: YAML tutorial in the context of Jekyll
url: /mydoc_yaml_tutorial/
url: /mydoc_yaml_tutorial
output: web, pdf
- title: Tags
url: /mydoc_tags/
url: /mydoc_tags
output: web, pdf
- title: Series
url: /mydoc_series/
url: /mydoc_series
output: web, pdf
- title: Formatting
output: web, pdf
folderitems:
- title: Tooltips
url: /mydoc_adding_tooltips/
url: /mydoc_adding_tooltips
output: web, pdf
- title: Alerts
url: /mydoc_alerts/
url: /mydoc_alerts
output: web, pdf
- title: Icons
url: /mydoc_icons/
url: /mydoc_icons
output: web, pdf
- title: Images
url: /mydoc_images/
url: /mydoc_images
output: web, pdf
- title: Code samples
url: /mydoc_code_samples
output: web, pdf
- title: Labels
url: /mydoc_labels/
url: /mydoc_labels
output: web, pdf
- title: Links
url: /mydoc_hyperlinks/
url: /mydoc_hyperlinks
output: web, pdf
- title: Navtabs
url: /mydoc_navtabs/
url: /mydoc_navtabs
output: web, pdf
- title: Tables
url: /mydoc_tables/
url: /mydoc_tables
output: web, pdf
- title: Syntax highlighting
url: /mydoc_syntax_highlighting/
url: /mydoc_syntax_highlighting
output: web, pdf
- title: Workflow maps
url: /mydoc_workflow_maps
output: web, pdf
- title: Handling reviews
output: web, pdf
folderitems:
- title: Commenting on files
url: /mydoc_commenting_on_files/
url: /mydoc_commenting_on_files
output: web, pdf
# - title: Git collaboration
# url: /mydoc_git_collaboration/
# url: /mydoc_git_collaboration
# output: web, pdf
- title: Publishing
output: web, pdf
folderitems:
- title: Build arguments
url: /mydoc_build_arguments/
url: /mydoc_build_arguments
output: web, pdf
- title: Themes
url: /mydoc_themes/
url: /mydoc_themes
output: web, pdf
- title: Check page title consistency
url: /mydoc_title_checker/
url: /mydoc_title_checker
output: web, pdf
- title: Generating PDFs
url: /mydoc_generating_pdfs/
url: /mydoc_generating_pdfs
output: web, pdf
- title: Help APIs and UI tooltips
url: /mydoc_help_api/
url: /mydoc_help_api
output: web, pdf
- title: Search configuration
url: /mydoc_search_configuration/
url: /mydoc_search_configuration
output: web, pdf
- title: iTerm profiles
url: /mydoc_iterm_profiles/
url: /mydoc_iterm_profiles
output: web, pdf
- title: Pushing builds to server
url: /mydoc_push_build_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/
url: /mydoc_no_password_prompts_scp
output: web, pdf
- title: Publishing on Github Pages
url: /mydoc_publishing_github_pages/
url: /mydoc_publishing_github_pages
output: web, pdf
- title: Special layouts
output: web, pdf
folderitems:
- title: Knowledge-base layout
url: /mydoc_kb_layout/
url: /mydoc_kb_layout
output: web, pdf
- title: Glossary layout
url: /mydoc_glossary/
url: /mydoc_glossary
output: web, pdf
- title: FAQ layout
url: /mydoc_faq_layout/
url: /mydoc_faq_layout
output: web, pdf
- title: Troubleshooting
output: web, pdf
folderitems:
- title: Troubleshooting
url: /mydoc_troubleshooting/
url: /mydoc_troubleshooting
output: web, pdf
- title: Tag archives
@ -242,7 +261,7 @@ entries:
folderitems:
- title: Tag archives overview
url: /mydoc_tag_archives_overview/
url: /mydoc_tag_archives_overview
output: web
subfolders:
@ -251,29 +270,29 @@ entries:
subfolderitems:
- title: Formatting pages
url: /tag_formatting/
url: /tag_formatting
output: web
- title: Navigation pages
url: /tag_navigation/
url: /tag_navigation
output: web
- title: Content types pages
url: /tag_content_types/
url: /tag_content_types
output: web
- title: Publishing pages
url: /tag_publishing/
url: /tag_publishing
output: web
- title: Special layout pages
url: /tag_special_layouts/
url: /tag_special_layouts
output: web
- title: Collaboration pages
url: /tag_collaboration/
url: /tag_collaboration
output: web
- title: Troubleshooting pages
url: /tag_troubleshooting/
output: web
url: /tag_troubleshooting
output: web

32
_data/sidebars/product1_sidebar.yml
View File

@ -12,11 +12,11 @@ entries:
type: frontmatter
folderitems:
- title:
url: /titlepage/
url: /titlepage
output: pdf
type: frontmatter
- title:
url: /tocpage/
url: /tocpage
output: pdf
type: frontmatter
@ -24,19 +24,19 @@ entries:
output: web, pdf
folderitems:
- title: Product 1 home
url: /p1_landing_page/
url: /p1_landing_page
output: web
- title: Sample 1
url: /p1_sample1/
url: /p1_sample1
output: web, pdf
- title: Sample 2
url: /p1_sample2/
url: /p1_sample2
output: web, pdf
- title: Sample 3
url: /p1_sample3/
url: /p1_sample3
output: web, pdf
- title: Another heading
@ -44,17 +44,17 @@ entries:
folderitems:
- title: Sample 4
url: /p1_sample4/
url: /p1_sample4
output: web, pdf
- title: Sample 5
url: /p1_sample5/
url: /p1_sample5
output: web, pdf
- title: Sample 6
url: /p1_sample6/
url: /p1_sample6
output: web, pdf
- title: Sample 7
url: /p1_sample7/
output: web, pdf
url: /p1_sample7
output: web, pdf

34
_data/sidebars/product2_sidebar.yml
View File

@ -12,11 +12,11 @@ entries:
folderitems:
- title:
url: /titlepage/
url: titlepage
output: pdf
type: frontmatter
- title:
url: /tocpage/
url: tocpage
output: pdf
type: frontmatter
@ -25,7 +25,7 @@ entries:
folderitems:
- title: Overview
url: /p2_landing_page/
url: /p2_landing_page
output: web
- title: Simple Workflow
@ -33,23 +33,23 @@ entries:
folderitems:
- title: Sample 1
url: /p2_sample1/
url: /p2_sample1
output: web, pdf
- title: Sample 2
url: /p2_sample2/
url: /p2_sample2
output: web, pdf
- title: Sample 3
url: /p2_sample3/
url: /p2_sample3
output: web, pdf
- title: Sample 4
url: /p2_sample4/
url: /p2_sample4
output: web, pdf
- title: Sample 5
url: /p2_sample5/
url: /p2_sample5
output: web, pdf
- title: Complex Workflow
@ -57,37 +57,37 @@ entries:
folderitems:
- title: Sample 6
url: /p2_sample6/
url: /p2_sample6
output: web, pdf
- title: Sample 7
url: /p2_sample7/
url: /p2_sample7
output: web, pdf
- title: Sample 8
url: /p2_sample8/
url: /p2_sample8
output: web, pdf
- title: Sample 9
url: /p2_sample9/
url: /p2_sample9
output: web, pdf
- title: Sample 10
url: /p2_sample10/
url: /p2_sample10
output: web, pdf
- title: Sample 11
url: /p2_sample11/
url: /p2_sample11
output: web, pdf
- title: Sample 12
url: /p2_sample12/
url: /p2_sample12
output: web, pdf
- title: Sample 13
url: /p2_sample13/
url: /p2_sample13
output: web, pdf
- title: Sample 14
url: /p2_sample14/
url: /p2_sample14
output: web, pdf

54
_data/sidebars/tags_sidebar.yml
View File

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

11
_data/topnav.yml
View File

@ -4,7 +4,7 @@ topnav:
- title: Topnav
items:
- title: News
url: /news/
url: /news
#Topnav dropdowns
topnav_dropdowns:
@ -25,11 +25,8 @@ topnav_dropdowns:
- title: Products
folderitems:
- title: Jekyll Documentation Theme
url: /mydoc_introduction/
url: /mydoc_introduction
- title: Product 1
url: /p1_landing_page/
url: /p1_landing_page
- title: Product 2
url: /p2_landing_page/
url: /p2_landing_page

686
_data/urls.yml
View File

@ -1,686 +0,0 @@
mydoc_release_notes_50:
title: "5.0 Release notes"
url: /documentation-theme-jekyll/mydoc_release_notes_50/
link: <a href="/documentation-theme-jekyll/mydoc_release_notes_50/">5.0 Release notes</a>
samplepage:
title: "Sample page"
url: /documentation-theme-jekyll/samplepage/
link: <a href="/documentation-theme-jekyll/samplepage/">Sample page</a>
mydoc_introduction:
title: "Introduction"
url: /documentation-theme-jekyll/mydoc_introduction/
link: <a href="/documentation-theme-jekyll/mydoc_introduction/">Introduction</a>
mydoc_supported_features:
title: "Supported features"
url: /documentation-theme-jekyll/mydoc_supported_features/
link: <a href="/documentation-theme-jekyll/mydoc_supported_features/">Supported features</a>
mydoc_about:
title: "About the theme author"
url: /documentation-theme-jekyll/mydoc_about/
link: <a href="/documentation-theme-jekyll/mydoc_about/">About the theme author</a>
mydoc_support:
title: "Support"
url: /documentation-theme-jekyll/mydoc_support/
link: <a href="/documentation-theme-jekyll/mydoc_support/">Support</a>
mydoc_about_ruby_gems_etc:
title: "About Ruby, Gems, Bundler, etc."
url: /documentation-theme-jekyll/mydoc_about_ruby_gems_etc/
link: <a href="/documentation-theme-jekyll/mydoc_about_ruby_gems_etc/">About Ruby, Gems, Bundler, etc.</a>
mydoc_install_jekyll_on_mac:
title: "Install Jekyll on Mac"
url: /documentation-theme-jekyll/mydoc_install_jekyll_on_mac/
link: <a href="/documentation-theme-jekyll/mydoc_install_jekyll_on_mac/">Install Jekyll on Mac</a>
mydoc_install_jekyll_on_windows:
title: "Install Jekyll on Windows"
url: /documentation-theme-jekyll/mydoc_install_jekyll_on_windows/
link: <a href="/documentation-theme-jekyll/mydoc_install_jekyll_on_windows/">Install Jekyll on Windows</a>
mydoc_pages:
title: "Pages"
url: /documentation-theme-jekyll/mydoc_pages/
link: <a href="/documentation-theme-jekyll/mydoc_pages/">Pages</a>
mydoc_posts:
title: "Posts"
url: /documentation-theme-jekyll/mydoc_posts/
link: <a href="/documentation-theme-jekyll/mydoc_posts/">Posts</a>
mydoc_webstorm_text_editor:
title: "WebStorm Text Editor"
url: /documentation-theme-jekyll/mydoc_webstorm_text_editor/
link: <a href="/documentation-theme-jekyll/mydoc_webstorm_text_editor/">WebStorm Text Editor</a>
mydoc_conditional_logic:
title: "Conditional logic"
url: /documentation-theme-jekyll/mydoc_conditional_logic/
link: <a href="/documentation-theme-jekyll/mydoc_conditional_logic/">Conditional logic</a>
mydoc_content_reuse:
title: "Content reuse"
url: /documentation-theme-jekyll/mydoc_content_reuse/
link: <a href="/documentation-theme-jekyll/mydoc_content_reuse/">Content reuse</a>
mydoc_collections:
title: "Collections"
url: /documentation-theme-jekyll/mydoc_collections/
link: <a href="/documentation-theme-jekyll/mydoc_collections/">Collections</a>
mydoc_sidebar_navigation:
title: "Sidebar navigation"
url: /documentation-theme-jekyll/mydoc_sidebar_navigation/
link: <a href="/documentation-theme-jekyll/mydoc_sidebar_navigation/">Sidebar navigation</a>
mydoc_yaml_tutorial:
title: "YAML tutorial in the context of Jekyll"
url: /documentation-theme-jekyll/mydoc_yaml_tutorial/
link: <a href="/documentation-theme-jekyll/mydoc_yaml_tutorial/">YAML tutorial in the context of Jekyll</a>
mydoc_tags:
title: "Tags"
url: /documentation-theme-jekyll/mydoc_tags/
link: <a href="/documentation-theme-jekyll/mydoc_tags/">Tags</a>
mydoc_series:
title: "Series"
url: /documentation-theme-jekyll/mydoc_series/
link: <a href="/documentation-theme-jekyll/mydoc_series/">Series</a>
mydoc_adding_tooltips:
title: "Tooltips"
url: /documentation-theme-jekyll/mydoc_adding_tooltips/
link: <a href="/documentation-theme-jekyll/mydoc_adding_tooltips/">Tooltips</a>
mydoc_alerts:
title: "Alerts"
url: /documentation-theme-jekyll/mydoc_alerts/
link: <a href="/documentation-theme-jekyll/mydoc_alerts/">Alerts</a>
mydoc_icons:
title: "Icons"
url: /documentation-theme-jekyll/mydoc_icons/
link: <a href="/documentation-theme-jekyll/mydoc_icons/">Icons</a>
mydoc_images:
title: "Images"
url: /documentation-theme-jekyll/mydoc_images/
link: <a href="/documentation-theme-jekyll/mydoc_images/">Images</a>
mydoc_labels:
title: "Labels"
url: /documentation-theme-jekyll/mydoc_labels/
link: <a href="/documentation-theme-jekyll/mydoc_labels/">Labels</a>
mydoc_hyperlinks:
title: "Links"
url: /documentation-theme-jekyll/mydoc_hyperlinks/
link: <a href="/documentation-theme-jekyll/mydoc_hyperlinks/">Links</a>
mydoc_navtabs:
title: "Navtabs"
url: /documentation-theme-jekyll/mydoc_navtabs/
link: <a href="/documentation-theme-jekyll/mydoc_navtabs/">Navtabs</a>
mydoc_tables:
title: "Tables"
url: /documentation-theme-jekyll/mydoc_tables/
link: <a href="/documentation-theme-jekyll/mydoc_tables/">Tables</a>
mydoc_syntax_highlighting:
title: "Syntax highlighting"
url: /documentation-theme-jekyll/mydoc_syntax_highlighting/
link: <a href="/documentation-theme-jekyll/mydoc_syntax_highlighting/">Syntax highlighting</a>
mydoc_commenting_on_files:
title: "Commenting on files"
url: /documentation-theme-jekyll/mydoc_commenting_on_files/
link: <a href="/documentation-theme-jekyll/mydoc_commenting_on_files/">Commenting on files</a>
mydoc_build_arguments:
title: "Build arguments"
url: /documentation-theme-jekyll/mydoc_build_arguments/
link: <a href="/documentation-theme-jekyll/mydoc_build_arguments/">Build arguments</a>
mydoc_themes:
title: "Themes"
url: /documentation-theme-jekyll/mydoc_themes/
link: <a href="/documentation-theme-jekyll/mydoc_themes/">Themes</a>
mydoc_title_checker:
title: "Check page title consistency"
url: /documentation-theme-jekyll/mydoc_title_checker/
link: <a href="/documentation-theme-jekyll/mydoc_title_checker/">Check page title consistency</a>
mydoc_generating_pdfs:
title: "Generating PDFs"
url: /documentation-theme-jekyll/mydoc_generating_pdfs/
link: <a href="/documentation-theme-jekyll/mydoc_generating_pdfs/">Generating PDFs</a>
mydoc_help_api:
title: "Help APIs and UI tooltips"
url: /documentation-theme-jekyll/mydoc_help_api/
link: <a href="/documentation-theme-jekyll/mydoc_help_api/">Help APIs and UI tooltips</a>
mydoc_search_configuration:
title: "Search configuration"
url: /documentation-theme-jekyll/mydoc_search_configuration/
link: <a href="/documentation-theme-jekyll/mydoc_search_configuration/">Search configuration</a>
mydoc_iterm_profiles:
title: "iTerm profiles"
url: /documentation-theme-jekyll/mydoc_iterm_profiles/
link: <a href="/documentation-theme-jekyll/mydoc_iterm_profiles/">iTerm profiles</a>
mydoc_push_build_to_server:
title: "Pushing builds to server"
url: /documentation-theme-jekyll/mydoc_push_build_to_server/
link: <a href="/documentation-theme-jekyll/mydoc_push_build_to_server/">Pushing builds to server</a>
mydoc_no_password_prompts_scp:
title: "Getting around the password prompts in SCP"
url: /documentation-theme-jekyll/mydoc_no_password_prompts_scp/
link: <a href="/documentation-theme-jekyll/mydoc_no_password_prompts_scp/">Getting around the password prompts in SCP</a>
mydoc_publishing_github_pages:
title: "Publishing on Github Pages"
url: /documentation-theme-jekyll/mydoc_publishing_github_pages/
link: <a href="/documentation-theme-jekyll/mydoc_publishing_github_pages/">Publishing on Github Pages</a>
mydoc_kb_layout:
title: "Knowledge-base layout"
url: /documentation-theme-jekyll/mydoc_kb_layout/
link: <a href="/documentation-theme-jekyll/mydoc_kb_layout/">Knowledge-base layout</a>
mydoc_glossary:
title: "Glossary layout"
url: /documentation-theme-jekyll/mydoc_glossary/
link: <a href="/documentation-theme-jekyll/mydoc_glossary/">Glossary layout</a>
mydoc_faq_layout:
title: "FAQ layout"
url: /documentation-theme-jekyll/mydoc_faq_layout/
link: <a href="/documentation-theme-jekyll/mydoc_faq_layout/">FAQ layout</a>
mydoc_troubleshooting:
title: "Troubleshooting"
url: /documentation-theme-jekyll/mydoc_troubleshooting/
link: <a href="/documentation-theme-jekyll/mydoc_troubleshooting/">Troubleshooting</a>
mydoc_tag_archives_overview:
title: "Tag archives overview"
url: /documentation-theme-jekyll/mydoc_tag_archives_overview/
link: <a href="/documentation-theme-jekyll/mydoc_tag_archives_overview/">Tag archives overview</a>
tag_formatting:
title: "Formatting pages"
url: /documentation-theme-jekyll/tag_formatting/
link: <a href="/documentation-theme-jekyll/tag_formatting/">Formatting pages</a>
tag_navigation:
title: "Navigation pages"
url: /documentation-theme-jekyll/tag_navigation/
link: <a href="/documentation-theme-jekyll/tag_navigation/">Navigation pages</a>
tag_content_types:
title: "Content types pages"
url: /documentation-theme-jekyll/tag_content_types/
link: <a href="/documentation-theme-jekyll/tag_content_types/">Content types pages</a>
tag_publishing:
title: "Publishing pages"
url: /documentation-theme-jekyll/tag_publishing/
link: <a href="/documentation-theme-jekyll/tag_publishing/">Publishing pages</a>
tag_special_layouts:
title: "Special layout pages"
url: /documentation-theme-jekyll/tag_special_layouts/
link: <a href="/documentation-theme-jekyll/tag_special_layouts/">Special layout pages</a>
tag_collaboration:
title: "Collaboration pages"
url: /documentation-theme-jekyll/tag_collaboration/
link: <a href="/documentation-theme-jekyll/tag_collaboration/">Collaboration pages</a>
tag_troubleshooting:
title: "Troubleshooting pages"
url: /documentation-theme-jekyll/tag_troubleshooting/
link: <a href="/documentation-theme-jekyll/tag_troubleshooting/">Troubleshooting pages</a>
p1_landing_page:
title: "Product 1 home"
url: /documentation-theme-jekyll/p1_landing_page/
link: <a href="/documentation-theme-jekyll/p1_landing_page/">Product 1 home</a>
p1_sample1:
title: "Sample 1"
url: /documentation-theme-jekyll/p1_sample1/
link: <a href="/documentation-theme-jekyll/p1_sample1/">Sample 1</a>
p1_sample2:
title: "Sample 2"
url: /documentation-theme-jekyll/p1_sample2/
link: <a href="/documentation-theme-jekyll/p1_sample2/">Sample 2</a>
p1_sample3:
title: "Sample 3"
url: /documentation-theme-jekyll/p1_sample3/
link: <a href="/documentation-theme-jekyll/p1_sample3/">Sample 3</a>
p1_sample4:
title: "Sample 4"
url: /documentation-theme-jekyll/p1_sample4/
link: <a href="/documentation-theme-jekyll/p1_sample4/">Sample 4</a>
p1_sample5:
title: "Sample 5"
url: /documentation-theme-jekyll/p1_sample5/
link: <a href="/documentation-theme-jekyll/p1_sample5/">Sample 5</a>
p1_sample6:
title: "Sample 6"
url: /documentation-theme-jekyll/p1_sample6/
link: <a href="/documentation-theme-jekyll/p1_sample6/">Sample 6</a>
p1_sample7:
title: "Sample 7"
url: /documentation-theme-jekyll/p1_sample7/
link: <a href="/documentation-theme-jekyll/p1_sample7/">Sample 7</a>
p2_landing_page:
title: "Simple Workflow"
url: /documentation-theme-jekyll/p2_landing_page/
link: <a href="/documentation-theme-jekyll/p2_landing_page/">Simple Workflow</a>
p2_sample1:
title: "Sample 1"
url: /documentation-theme-jekyll/p2_sample1/
link: <a href="/documentation-theme-jekyll/p2_sample1/">Sample 1</a>
p2_sample2:
title: "Sample 2"
url: /documentation-theme-jekyll/p2_sample2/
link: <a href="/documentation-theme-jekyll/p2_sample2/">Sample 2</a>
p2_sample3:
title: "Sample 3"
url: /documentation-theme-jekyll/p2_sample3/
link: <a href="/documentation-theme-jekyll/p2_sample3/">Sample 3</a>
p2_sample4:
title: "Sample 4"
url: /documentation-theme-jekyll/p2_sample4/
link: <a href="/documentation-theme-jekyll/p2_sample4/">Sample 4</a>
p2_sample5:
title: "Sample 5"
url: /documentation-theme-jekyll/p2_sample5/
link: <a href="/documentation-theme-jekyll/p2_sample5/">Sample 5</a>
p2_sample6:
title: "Sample 6"
url: /documentation-theme-jekyll/p2_sample6/
link: <a href="/documentation-theme-jekyll/p2_sample6/">Sample 6</a>
p2_sample7:
title: "Sample 7"
url: /documentation-theme-jekyll/p2_sample7/
link: <a href="/documentation-theme-jekyll/p2_sample7/">Sample 7</a>
p2_sample8:
title: "Sample 8"
url: /documentation-theme-jekyll/p2_sample8/
link: <a href="/documentation-theme-jekyll/p2_sample8/">Sample 8</a>
p2_sample9:
title: "Sample 9"
url: /documentation-theme-jekyll/p2_sample9/
link: <a href="/documentation-theme-jekyll/p2_sample9/">Sample 9</a>
p2_sample10:
title: "Sample 10"
url: /documentation-theme-jekyll/p2_sample10/
link: <a href="/documentation-theme-jekyll/p2_sample10/">Sample 10</a>
p2_sample11:
title: "Sample 11"
url: /documentation-theme-jekyll/p2_sample11/
link: <a href="/documentation-theme-jekyll/p2_sample11/">Sample 11</a>
p2_sample12:
title: "Sample 12"
url: /documentation-theme-jekyll/p2_sample12/
link: <a href="/documentation-theme-jekyll/p2_sample12/">Sample 12</a>
p2_sample13:
title: "Sample 13"
url: /documentation-theme-jekyll/p2_sample13/
link: <a href="/documentation-theme-jekyll/p2_sample13/">Sample 13</a>
p2_sample14:
title: "Sample 14"
url: /documentation-theme-jekyll/p2_sample14/
link: <a href="/documentation-theme-jekyll/p2_sample14/">Sample 14</a>
news:
title: "News"
url: "news"
link: "<a href='/news/'>News</a>"
mydoc_introduction:
title: "Jekyll Documentation Theme"
url: "mydoc_introduction"
link: "<a href='/mydoc_introduction/'>Jekyll Documentation Theme</a>"
p1_landing_page:
title: "Product 1"
url: "p1_landing_page"
link: "<a href='/p1_landing_page/'>Product 1</a>"
p2_landing_page:
title: "Product 2"
url: "p2_landing_page"
link: "<a href='/p2_landing_page/'>Product 2</a>"
news:
title: "News"
url: "news"
link: "<a href='/news/'>News</a>"
mydoc_introduction:
title: "Jekyll Documentation Theme"
url: "mydoc_introduction"
link: "<a href='/mydoc_introduction/'>Jekyll Documentation Theme</a>"
p1_landing_page:
title: "Product 1"
url: "p1_landing_page"
link: "<a href='/p1_landing_page/'>Product 1</a>"
p2_landing_page:
title: "Product 2"
url: "p2_landing_page"
link: "<a href='/p2_landing_page/'>Product 2</a>"

3
_includes/custom/sidebarconfigs.html
View File

@ -10,9 +10,6 @@
{% 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 %}

19
_includes/custom/usermap.html
View File

@ -1,15 +1,14 @@
<div id="userMap">
<div class="content"><a href="{{site.data.urls.p2_sample1.url}}"><div class="box box1">Connect to ADB</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="{{site.data.urls.p2_sample2.url}}"><div class="box box2">Download and Build the Starter Kit</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="{{site.data.urls.p2_sample3.url}}"><div class="box box3">Take a Tour</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="{{site.data.urls.p2_sample4.url}}"><div class="box box4">Load Your Widgets</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="{{site.data.urls.p2_sample5.url}}"><div class="box box5">Query for Something</div></a></div>
<div class="content"><a href="p2_sample1.html"><div class="box box1">Connect to ADB</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample2.html"><div class="box box2">Download and Build the Starter Kit</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample3.html"><div class="box box3">Take a Tour</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample4.html"><div class="box box4">Load Your Widgets</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample5.html"><div class="box box5">Query for Something</div></a></div>
<div class="clearfix"></div>
</div>

18
_includes/custom/usermapcomplex.html
View File

@ -15,9 +15,9 @@
<p>This is just dummy text ... Your first steps should be to get started. You will need to do the following:</p>
<ul>
<li>{{site.data.urls.p2_sample6.link}}</li>
<li>{{site.data.urls.p2_sample7.link}}</li>
<li>{{site.data.urls.p2_sample8.link}}</li>
<li><a href="p2_sample6.html">Sample 6</a></li>
<li><a href="p2_sample7.html">Sample 7</a></li>
<li><a href="p2_sample8.html">Sample 8</a></li>
</ul>
<p>If you run into any of these setup issues, you must solve them before you can continue on.</p>
@ -45,9 +45,9 @@
<p>In order to configure your widgets, you will need to follow these topics:</p>
<ul>
<li>{{site.data.urls.p2_sample9.link}}</li>
<li>{{site.data.urls.p2_sample10.link}}</li>
<li>{{site.data.urls.p2_sample11.link}}</li>
<li><a href="p2_sample9.html">Sample 9</a></li>
<li><a href="p2_sample10.html">Sample 10</a></li>
<li><a href="p2_sample11.html">Sample 11</a></li>
</ul>
</div>
<div class="modal-footer">
@ -73,9 +73,9 @@
<p>After you've configured all the necessary components to build your space transformer, you need to publish your app. Of course this content is also just dummy text. Pay no particular attention to the content but rather the format and placement of the map.</p>
<p>To publish your app, see the following:
<ul>
<li>{{site.data.urls.p2_sample12.link}}</li>
<li>{{site.data.urls.p2_sample13.link}}</li>
<li>{{site.data.urls.p2_sample14.link}}</li>
<li><a href="p2_sample12.html">Sample 12</a></li>
<li><a href="p2_sample13.html">Sample 13</a></li>
<li><a href="p2_sample14.html">Sample 14</a></li>
</ul>
</div>
<div class="modal-footer">

4
_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="{{ "/images/company_logo.png" | prepend: site.baseurl }}" alt="Company logo"/></p>
<p><img src="{{ "images/company_logo.png" }}" alt="Company logo"/></p>
</div>
</div>
</footer>
</footer>

27
_includes/head.html
View File

@ -3,28 +3,28 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
<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" href="{{ "/css/syntax.css" | prepend: site.baseurl }}">
<title>{{ page.title }} | {{ site.site_title }}</title>
<link rel="stylesheet" href="{{ "css/syntax.css" }}">
<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-blue.css" | prepend: site.baseurl }}">
<link rel="stylesheet" href="{{ "css/modern-business.css" }}">
<link rel="stylesheet" href="{{ "css/lavish-bootstrap.css" }}">
<link rel="stylesheet" href="{{ "css/customstyles.css" }}">
<link rel="stylesheet" href="{{ "css/theme-blue.css" }}">
<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" | prepend: site.baseurl }}"></script>
<script src="{{ "js/jquery.navgoco.min.js" }}"></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" | prepend: site.baseurl }}"></script>
<script src="{{ "/js/customscripts.js" | prepend: site.baseurl }}"></script>
<script src="{{ "js/toc.js" }}"></script>
<script src="{{ "js/customscripts.js" }}"></script>
<link rel="shortcut icon" href="{{ "/images/favicon.ico" | prepend: site.baseurl }}">
<link rel="shortcut icon" href="{{ "images/favicon.ico" }}">
<!-- 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:// -->
@ -33,9 +33,4 @@
<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 }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "feed.xml" | prepend: site.url }}">

2
_includes/image.html
View File

@ -1 +1 @@
<figure>{% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}<img class="docimage" src="{{site.baseurl | prepend: site.url}}/images/{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />{% if {{include.url}} %}</a>{% endif %}{% if {{include.caption}} %}<figcaption>{{include.caption}}</figcaption></figure>{% endif %}
<figure>{% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}<img class="docimage" src="../images/{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />{% if {{include.url}} %}</a>{% endif %}{% if {{include.caption}} %}<figcaption>{{include.caption}}</figcaption></figure>{% endif %}

2
_includes/inline_image.html
View File

@ -1 +1 @@
<img class="inline" src="{{site.image_path}}/{{include.file}}{% if site.target == "hippo" %}._TTH_{% endif %}.{{include.type}}" alt="{{include.alt}}" />
<img class="inline" src="images/{{include.file}}" alt="{{include.alt}}" />

54
_includes/links.html Normal file
View File

@ -0,0 +1,54 @@
{% comment %}Get links from each sidebar, as listed in the _config.yml file under sidebars{% endcomment %}
{% for sidebar in site.sidebars %}
{% for entry in site.data.sidebars[sidebar].entries %}
{% for folder in entry.folders %}
{% for folderitem in folder.folderitems %}
[{{folderitem.url | remove: "/" }}]: {{folderitem.url | remove: "/" | append: ".html"}}
{% for subfolders in folderitem.subfolders %}
{% for subfolderitem in subfolders.subfolderitems %}
[{{subfolderitem.url | remove: "/" }}]: {{subfolderitem.url | remove: "/" | append: ".html"}}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% comment %} Get links from topnav {% endcomment %}
{% for entry in site.data.topnav.topnav %}
{% for item in entry.items %}
{% if item.external_url == null %}
[{{item.url | remove: "/" }}]: {{item.url | remove: "/" | append: ".html"}}
{% endif %}
{% endfor %}
{% endfor %}
{% comment %}Get links from topnav dropdowns {% endcomment %}
{% for entry in site.data.topnav.topnav_dropdowns %}
{% for folder in entry.folders %}
{% for folderitem in folder.folderitems %}
{% if folderitem.external_url == null %}
[{{folderitem.url | remove: "/" }}]: {{folderitem.url | remove: "/" | append: ".html"}}
{% endif %}
{% endfor %}
{% endfor %}
{% endfor %}
{% comment %}Get links for otherlinks.yml file {% endcomment %}
{% for entry in site.data.otherlinks.entries %}
{% for folder in entry.folders %}
{% for folderitem in folder.folderitems %}
[{{folderitem.ref}}]: {{folderitem.exact_url}}
{% for subfolders in folderitem.subfolders %}
{% for subfolderitem in subfolders.subfolderitems %}
[{{subfolderitem.ref}}]: {{subfolderitem.exact_url}}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}

10
_includes/sidebar.html
View File

@ -13,9 +13,9 @@
{% if folderitem.external_url %}
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>
{% elsif page.url == folderitem.url %}
<li class="active"><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
<li class="active"><a href="{{folderitem.url | remove: "/" | append: ".html"}}">{{folderitem.title}}</a></li>
{% else %}
<li><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
<li><a href="{{folderitem.url | remove: "/" | append: ".html"}}">{{folderitem.title}}</a></li>
{% endif %}
{% for subfolders in folderitem.subfolders %}
{% if subfolders.output contains "web" %}
@ -27,9 +27,9 @@
{% if subfolderitem.external_url %}
<li><a href="{{subfolderitem.external_url}}" target="_blank">{{subfolderitem.title}}</a></li>
{% elsif page.url == subfolderitem.url %}
<li class="active"><a href="{{subfolderitem.url | prepend: site.baseurl}}">{{subfolderitem.title}}</a></li>
<li class="active"><a href="{{subfolderitem.url | remove: "/" | append: ".html"}}">{{subfolderitem.title}}</a></li>
{% else %}
<li><a href="{{subfolderitem.url | prepend: site.baseurl}}">{{subfolderitem.title}}</a></li>
<li><a href="{{subfolderitem.url | remove: "/" | append: ".html"}}">{{subfolderitem.title}}"</a></li>
{% endif %}
{% endif %}
{% endfor %}
@ -53,4 +53,4 @@
</div>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
<script>$("li.active").parents('li').toggleClass("active");</script>

4
_includes/taglogic.html
View File

@ -6,7 +6,7 @@
{% for tag in page.tags %}
{% if tag == thisTag %}
<tr><td><a href="{{ page.url | prepend: site.baseurl }}">{{page.title}}</a></td>
<tr><td><a href="{{ page.url | remove: "/"}}">{{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>
@ -19,7 +19,7 @@
{% for tag in post.tags %}
{% if tag == thisTag %}
<tr><td><a href="{{ post.url | prepend: site.baseurl }}">{{post.title}}</a></td>
<tr><td><a href="{{ post.url | remove: "/"}}">{{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>

16
_includes/topnav.html
View File

@ -8,7 +8,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="fa fa-home fa-lg navbar-brand" href="{{site.baseurl}}/">&nbsp;<span class="projectTitle"> {{site.topnav_title}}</span></a>
<a class="fa fa-home fa-lg navbar-brand" href="index.html">&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">
@ -18,9 +18,9 @@
{% if item.external_url %}
<li><a href="{{item.external_url}}" target="_blank">{{item.title}}</a></li>
{% elsif page.url contains item.url %}
<li class="active"><a href="{{item.url | prepend: site.baseurl}}">{{item.title}}</a></li>
<li class="active"><a href="{{item.url | remove: "/" | append: ".html"}}">{{item.title}}</a></li>
{% else %}
<li><a href="{{item.url | prepend: site.baseurl }}">{{item.title}}</a></li>
<li><a href="{{item.url | remove: "/" | append: ".html"}}">{{item.title}}</a></li>
{% endif %}
{% endfor %}
{% endfor %}
@ -35,9 +35,9 @@
{% if folderitem.external_url %}
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>
{% elsif page.url contains folderitem.url %}
<li class="dropdownActive"><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
<li class="dropdownActive"><a href="{{folderitem.url | remove: "/" | append: ".html"}}">{{folderitem.title}}</a></li>
{% else %}
<li><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a></li>
<li><a href="{{folderitem.url | remove: "/" | append: ".html"}}">{{folderitem.title}}</a></li>
{% endif %}
{% endfor %}
</ul>
@ -54,12 +54,12 @@
<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" | prepend: site.baseurl }}" type="text/javascript"></script>
<script src="{{ "js/jekyll-search.js"}}" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: '{{ "/search.json" | prepend: site.baseurl }}',
dataSource: '{{ "../search.json" }}',
searchResultTemplate: '<li><a href="{url}" title="{{page.title | replace: "'", "\"}}">{title}</a></li>',
noResultsText: '{{site.data.strings.search_no_results_text}}',
limit: 10,
@ -72,4 +72,4 @@
</div>
</div>
<!-- /.container -->
</nav>
</nav>

17
_layouts/page.html
View File

@ -3,14 +3,23 @@ layout: default
---
<div class="post-header">
<h1 class="post-title-main">{% if page.homepage == true %} {{site.homepage_title}} {% else %}{{ page.title }}{% endif %}</h1>
<h1 class="post-title-main">{{ page.title }}</h1>
</div>
{% if page.map == true %}
{% if page.simple_map == true %}
<script>
$(document).ready ( function(){
$('.box{{page.box_number}}').addClass('active');
});
</script>
{% include custom/{{page.map_name}}.html %}
{% elsif page.complex_map == true %}
<script>
$(document).ready ( function(){
$('.modalButton{{page.box_number}}').addClass('active');
});
</script>
@ -33,7 +42,7 @@ layout: default
{% if site.github_editme_path %}
<a target="_blank" href="https://github.com/{{site.github_editme_path}}/{{page.folder}}/{{page.url | remove: "/" | append: ".md"}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
<a target="_blank" href="https://github.com/{{site.github_editme_path}}/_pages/{{page.folder}}/{{page.url | remove: "/" | append: ".md"}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
{% endif %}
{% endunless %}
@ -46,7 +55,7 @@ layout: default
{% assign projectTags = site.data.tags.allowed-tags %}
{% for tag in page.tags %}
{% if projectTags contains tag %}
<a href="{{ "/tag_" | prepend: site.baseurl | append: tag }}" class="btn btn-default navbar-btn cursorNorm" role="button">{{page.tagName}}{{tag}}</a>
<a href="{{ "tag_" | append: tag }}" class="btn btn-default navbar-btn cursorNorm" role="button">{{page.tagName}}{{tag}}</a>
{% endif %}
{% endfor %}
{% endif %}

1
_layouts/page_print.html
View File

@ -13,4 +13,3 @@ comments: true
{% endif %}
{{ content }}
</div>

6
_layouts/post.html
View File

@ -9,7 +9,7 @@ layout: default
{% assign projectTags = site.data.tags.allowed-tags %}
{% for tag in page.tags %}
{% if projectTags contains tag %}
<a href="{{ "/tag_" | prepend: site.baseurl | append: tag }}">{{tag}}</a>{% unless forloop.last %}, {% endunless%}
<a href="{{ "../tag_" | append: tag }}">{{tag}}</a>{% unless forloop.last %}, {% endunless%}
{% endif %}
{% endfor %}
{% endif %}
@ -39,7 +39,3 @@ layout: default
{{site.data.alerts.hr_shaded}}
{% include footer.html %}

6
mydoc/mydoc_about.md → _pages/mydoc/mydoc_about.md
View File

@ -1,11 +1,11 @@
---
title: About the theme author
keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements
last_updated: March 20, 2016
last_updated: July 3, 2016
tags: [getting_started]
summary: "I have used this theme for projects that I've worked on as a professional technical writer."
sidebar: mydoc_sidebar
permalink: /mydoc_about/
permalink: mydoc_about
folder: mydoc
---
@ -18,3 +18,5 @@ I think this theme does pretty much everything that you can do with something li
With a completely open architecture and code base, you can modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code.
If there's a feature you need but it isn't available here, let me know and I might add it. Alternatively, if you fork the theme, I would love to see your modifications and enhancements.
{% include links.html %}

4
mydoc/mydoc_about_ruby_gems_bundler.md → _pages/mydoc/mydoc_about_ruby_gems_bundler.md
View File

@ -4,7 +4,7 @@ tags: [getting_started, troubleshooting]
keywords:
summary: "Ruby is a programming language you must have on your computer in order to build Jekyll locally. Ruby has various gems (or plugins) that provide various functionality. Each Jekyll project usually requires certain gems."
sidebar: mydoc_sidebar
permalink: /mydoc_about_ruby_gems_etc/
permalink: mydoc_about_ruby_gems_etc
folder: mydoc
---
@ -250,3 +250,5 @@ BUNDLED WITH
You can always delete the Gemlock file and run Bundle install again to get the latest versions. You can also run `bundle update`, which will ignore the Gemlock file to get the latest versions of each gem.
To learn more about Bundler, see [Bundler's Purpose and Rationale](http://bundler.io/rationale.html).
{% include links.html %}

6
mydoc/mydoc_adding_tooltips.md → _pages/mydoc/mydoc_adding_tooltips.md
View File

@ -2,10 +2,10 @@
title: Tooltips
tags: [formatting]
keywords: popovers, tooltips, user interface text, glossaries, definitions
last_updated: March 20, 2016
last_updated: July 3, 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/
permalink: mydoc_adding_tooltips
folder: mydoc
---
@ -23,3 +23,5 @@ 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.
{% include links.html %}

8
mydoc/mydoc_alerts.md → _pages/mydoc/mydoc_alerts.md
View File

@ -2,10 +2,10 @@
title: Alerts
tags: [formatting]
keywords: notes, tips, cautions, warnings, admonitions
last_updated: March 20, 2016
last_updated: July 3, 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/
permalink: mydoc_alerts
folder: mydoc
---
@ -14,7 +14,7 @@ Alerts are little warnings, info, or other messages that you have called out in
## Alerts
Similar to [inserting images]({{site.data.urls.mydoc_images.url}}), you insert alerts through various includes that have been developed. These includes provide templates through which you pass parameters to easily populate the right HTML code.
Similar to [inserting images][mydoc_images]), you insert alerts through various includes that have been developed. These includes provide templates through which you pass parameters to easily populate the right HTML code.
```
{%raw%}{% include note.html content="This is my note. All the content I type here is treated as a single paragraph." %}{% endraw%}
@ -180,3 +180,5 @@ In this case, the quotation marks aren't set correctly. I forgot the closing quo
## Blast a warning to users on every page
If you want to blast a warning to users on every page, add the alert or callout to the \_layouts/page.html page right below the frontmatter. Every page using the page layout (all, by defaut) will show this message.
{% include links.html %}

35
_pages/mydoc/mydoc_atom_text_editor.md Normal file
View File

@ -0,0 +1,35 @@
---
title: Atom Text Editor
keywords: atom, text editor,
last_updated: March 20, 2016
summary: "Atom is a free text editor that is a favorite tool of many writers because it is free. This page provides some tips for using Atom."
sidebar: mydoc_sidebar
permalink: mydoc_atom_text_editor
folder: mydoc
---
If you haven't downloaded [Atom](https://atom.io/), download and install it. Use this as your editor when working with Jekyll. The syntax highlighting is probably the best among the available editors, as it was designed with Jekyll-authoring in mind. However, if you prefer Sublime Text, WebStorm, or some other editor, you can also use that.
Customize the invisibles and tab spacing in Atom:
1. Go to **Atom > Preferences**.
2. On the **Settings** tab, keep the default options but also select the following:
* **Show Invisibles**
* **Soft Wrap**
* For the **Tab Length**, type **4**.
* For the **Tab Type**, select **soft**.
Turn off auto-complete:
1. Go to **Atom > Preferences**.
2. Click the **Packages** tab.
3. Search for **autocomplete-plus**.
4. Disable the autocomplete package.
### Atom Shortcuts
* **Cmd + T**: Find file
* **Cmd + Shift + F**: Find across project
* **Cmd + Alt + S**: Save all
(For Windows, replace "Cmd" with "Ctrl".)

10
mydoc/mydoc_build_arguments.md → _pages/mydoc/mydoc_build_arguments.md
View File

@ -2,10 +2,10 @@
title: Build arguments
tags: [publishing]
keywords: building, serving, serve, build
last_updated: March 20, 2016
last_updated: July 3, 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/
permalink: mydoc_build_arguments
folder: mydoc
---
@ -23,7 +23,7 @@ To build the site and view it in a live server so that Jekyll rebuilds that site
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:
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/myspecialconfig.yml --destination ../doc_outputs
@ -39,7 +39,7 @@ If you have a long build argument and don't want to enter it every time in Jekyl
. myscript.sh
```
My preference is to add the scripts to profiles in iTerm. See {{site.data.urls.mydoc_iterm_profiles.link}} for more details.
My preference is to add the scripts to profiles in iTerm. See [iTerm Profiles][mydoc_iterm_profiles] for more details.
## Stop a server
@ -64,3 +64,5 @@ kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}')
I recommend creating a profile in iTerm that stores this command. Here's what the iTerm settings look like:
![iTerm profile settings to kill all Jekyll]({{ "/images/killalljekyll.png" | prepend: site.baseurl }})
{% include links.html %}

9
mydoc/mydoc_build_scripts.md → _pages/mydoc/mydoc_build_scripts.md
View File

@ -8,7 +8,7 @@ summary: "You need to customize the build scripts. These script automate the pub
series: "Getting Started"
weight: 10
sidebar: mydoc_sidebar
permalink: /mydoc_build_scripts/
permalink: mydoc_build_scripts
folder: mydoc
---
@ -41,7 +41,7 @@ To set up your projects:
For the mydocs project, you'll see a series of build scripts for each project. There are 5 build scripts, described in the following sections. Note that you really only need to run the last one, e.g., mydoc_all.sh, because it runs all of the build scripts. But you have to make sure each script is correctly configured so that they all build successfully.
{{site.data.alerts.tip}}In the descriptions of the build scripts, "mydoc" is used as the sample project. Substitute in whatever your real project name is. {{site.data.alerts.end}}
{% include tip.html content="In the descriptions of the build scripts, \"mydoc\" is used as the sample project. Substitute in whatever your real project name is." %}
### mydoc_1_multiserve_pdf.sh
@ -151,7 +151,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_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 [Getting around the password prompts in SCP][mydoc_no_password_prompts_scp]. Otherwise the script will stop and ping you to enter your password for each directory it transfers.
### (Optional) Push to repositories
@ -191,4 +191,7 @@ 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/getting_started_series_next.html %}
{% include links.html %}

27
_pages/mydoc/mydoc_code_samples.md Normal file
View File

@ -0,0 +1,27 @@
---
title: Code samples
tags: [formatting]
keywords: dcode samples syntax highlighting
last_updated: July 3, 2016
datatable: true
summary: "You can use fenced code blocks with the language specified after the first set of backtick fences."
sidebar: mydoc_sidebar
permalink: mydoc_code_samples
folder: mydoc
---
## Code Samples
Use fenced code blocks with the language specified, like this:
```js
console.log('hello');
````
**Result:**
```js
console.log('hello');
```
For the list of supported languages you can use (similar to `js` for JavaScript), see [Supported languages](https://github.com/jneen/rouge/wiki/list-of-supported-languages-and-lexers).

8
mydoc/mydoc_collections.md → _pages/mydoc/mydoc_collections.md
View File

@ -2,10 +2,10 @@
title: Collections
tags: [content_types]
keywords: groups, api, structure
last_updated: March 20, 2016
last_updated: July 3, 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/
permalink: mydoc_collections
folder: mydoc
---
@ -31,8 +31,10 @@ 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_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 [Help APIs and UI tooltips][mydoc_help_api] 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.
{% include links.html %}

8
mydoc/mydoc_commenting_on_files.md → _pages/mydoc/mydoc_commenting_on_files.md
View File

@ -6,7 +6,7 @@ keywords: "annotations, comments, feedback"
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/
permalink: mydoc_commenting_on_files
folder: mydoc
---
@ -47,7 +47,7 @@ If you want people to collaborate on your project so that their edits get commit
If you don't want to allow anyone to commit to your Github branch, don't add the reviewers as collaborators. When someone makes an edit, Github will fork the theme. The person's edit then will appear as a pull request to your repo. You can then choose to merge the change indicated in the pull or not.
{{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}}
{% include note.html content="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." %}
## Workflow
@ -58,8 +58,10 @@ When you're finished making all updates in the branch, you can merge the branch
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}}
{% include warning.html content="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." %}
## 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.
{% include links.html %}

8
mydoc/mydoc_conditional_logic.md → _pages/mydoc/mydoc_conditional_logic.md
View File

@ -2,10 +2,10 @@
title: Conditional logic
tags: [single_sourcing]
keywords: if else logic, conditions, conditional attributes, conditional filtering
last_updated: March 20, 2016
last_updated: July 3, 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/
permalink: mydoc_conditional_logic
folder: mydoc
---
@ -18,7 +18,7 @@ As such, the conditional logic won't have as much play as it previously did. Ins
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}}
{% include tip.html content="Definitely check out [Liquid's documentation](http://docs.shopify.com/themes/liquid-documentation/basics) for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site." %}
## Where to store filtering values
@ -152,3 +152,5 @@ Then create a folder called \_data_beta.
If you have a lot of conditions in your text, it can get confusing. As a best practice, whenever you insert an `if` condition, add the `endif` at the same time. This will reduce the chances of forgetting to close the if statement. Jekyll won't build if there are problems with the liquid logic.
If your text is getting busy with a lot of conditional statements, consider putting a lot of content into includes so that you can more easily see where the conditions begin and end.
{% include links.html %}

8
mydoc/mydoc_content_reuse.md → _pages/mydoc/mydoc_content_reuse.md
View File

@ -2,10 +2,10 @@
title: Content reuse
tags: [single_sourcing]
keywords: includes, conref, dita, transclusion, transclude, inclusion, reference
last_updated: March 20, 2016
last_updated: July 3, 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/
permalink: mydoc_content_reuse
folder: mydoc
---
@ -32,7 +32,7 @@ You can also create custom variables in your frontmatter like this:
```yaml
---
title: Page-level variables
permalink: /page_level_variables/
permalink: page_level_variables/
thing1: Joe
thing2: Dave
---
@ -50,3 +50,5 @@ thing2: {{page.thing2}}
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.
{% include links.html %}

6
mydoc/mydoc_excluding_files.md → _pages/mydoc/mydoc_excluding_files.md
View File

@ -1,11 +1,11 @@
---
title: Excluding files
tags: [single_sourcing]
last_updated: March 20, 2016
last_updated: July 3, 2016
keywords: exclusion, separating outputs, removing files from outputs
summary: "By default, all the files in your Jekyll project are included in the output (this differs from DITA projects, which don't include files unless noted on the map). If you're single sourcing, you'll need to exclude the files that shouldn't be included in the output. The sidebar doesn't control inclusion or exclusion."
sidebar: mydoc_sidebar
permalink: /mydoc_exluding_files/
permalink: mydoc_exluding_files
folder: mydoc
---
@ -82,3 +82,5 @@ If you're working on a draft, put it inside the \_drafts folder or add `publishe
## Limitations
What if a file should appear in two projects but not the third? This can get tricky. For some files, rather than using a wildcard, you may need to manually specify the entire filename that you're excluding instead of excluding it by way of a wildcard pattern.
{% include links.html %}

4
mydoc/mydoc_faq.html → _pages/mydoc/mydoc_faq.html
View File

@ -1,6 +1,6 @@
---
title: FAQ layout
permalink: /mydoc_faq_layout/
permalink: mydoc_faq_layout
sidebar: mydoc_sidebar
tags: [special_layouts]
keywords: frequently asked questions, FAQ, question and answer, collapsible sections, expand, collapse
@ -132,3 +132,5 @@ folder: mydoc
<!-- /.panel -->
</div>
<!-- /.panel-group -->
{% include links.html %}

25
mydoc/mydoc_generating_pdfs.md → _pages/mydoc/mydoc_generating_pdfs.md
View File

@ -1,9 +1,9 @@
---
title: Generating PDFs
permalink: /mydoc_generating_pdfs/
permalink: mydoc_generating_pdfs
tags: [publishing, single_sourcing, content_types]
keywords: PDF, prince, prince XML, ant, xsl fo
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can generate a PDF from your Jekyll project. You do this by creating a web version of your project that is printer friendly. You then use utility called Prince to iterate through the pages and create a PDF from them. It works quite well and gives you complete control to customize the PDF output through CSS, including page directives and dynamic tags from Prince."
sidebar: mydoc_sidebar
folder: mydoc
@ -56,7 +56,7 @@ defaults:
search: true
```
{{site.data.alerts.note}} Although you're creating a PDF, you must still build an HTML web target before running Prince. Prince will pull from the HTML files and from the file-list for the TOC. {{site.data.alerts.end}}
{% include note.html content="Although you're creating a PDF, you must still build an HTML web target before running Prince. Prince will pull from the HTML files and from the file-list for the TOC." %}
Note that the default page layout specified by this configuration file is `page_print`. This layout strips out all the sections that shouldn't appear in the print PDF, such as the sidebar and top navigation bar.
@ -94,7 +94,7 @@ The code in the tocpage.html is mostly identical to that of the sidebar.html pag
There's another file (in the root directory of the theme) that is critical to the PDF generation process: prince-list.txt. This file simply iterates through the items in your sidebar and creates a list of links. Prince will consume the list of links from prince-list.txt and create a running PDF that contains all of the pages listed, with appropriate cross references and styling for them all.
{{site.data.alerts.note}} If you have any files that you do not want to appear in the PDF, add <code>output: web</code> (rather than <code>output: pdf</code>) in the list of attributes in your sidebar. The prince-list.txt file that loops through the mydoc_sidebar.yml file to grab the URLs of each page that should appear in the PDF will skip over any items that do not list <code>output: pdf</code> in the item attributes. For example, you might not want your tag archives to appear in the PDF, but you probably will want to list them in the online help navigation. {{site.data.alerts.end}}
{% include note.html content="If you have any files that you do not want to appear in the PDF, add <code>output: web</code> (rather than <code>output: pdf</code>) in the list of attributes in your sidebar. The prince-list.txt file that loops through the mydoc_sidebar.yml file to grab the URLs of each page that should appear in the PDF will skip over any items that do not list <code>output: pdf</code> in the item attributes. For example, you might not want your tag archives to appear in the PDF, but you probably will want to list them in the online help navigation." %}
## 4. Customize your headers and footers
@ -120,7 +120,7 @@ a[href*="mailto"]::after, a[data-toggle="tooltip"]::after, a[href].noCrossRef::a
```
{% endraw %}
{{site.data.alerts.tip}} If you have a link to a file download, or some other link that shouldn't have a cross reference (such as link used in JavaScript for navtabs or collapsible sections, for example, add `noCrossRef` as a class to the link to avoid having it say "page 0" in the cross reference.{{site.data.alerts.end}}
{% include tip.html content="If you have a link to a file download, or some other link that shouldn't have a cross reference (such as link used in JavaScript for navtabs or collapsible sections, for example, add `noCrossRef` as a class to the link to avoid having it say \"page 0\" in the cross reference." %}
This style specifies that after links to web resources, the URL should be inserted instead of the page number:
@ -314,19 +314,14 @@ The prince script issues a command to the Prince utility. JavaScript is enabled
Make sure that the path to the prince-list.txt is correct. For the output directory, I like to output the PDF file into my project's source (into the files folder). Then when I build the web output, the PDF is included and something I can refer to.
{{site.data.alerts.note}} You might not want to include the PDF in your project files, since you're likely committing the PDF to Github and as a result saving the changes from one PDF version to another with each save. {{site.data.alerts.end}}
{% include note.html content="You might not want to include the PDF in your project files, since you're likely committing the PDF to Github and as a result saving the changes from one PDF version to another with each save." %}
## 6. Add conditions for your new builds in the sidebarconfigs.html file
In the \_includes/custom/sidebarconfigs.html file, there's a section that looks like this:
```
{% comment %}
sidebar configuration for print files
{% endcomment %}
{% if site.product == "mydoc" %}
{% raw %}{% if site.product == "mydoc" %}
{% assign sidebar_pdf = site.data.sidebars.mydoc_sidebar.entries %}
{% endif %}
@ -336,7 +331,7 @@ sidebar configuration for print files
{% if site.product == "product2" %}
{% assign sidebar_pdf = site.data.sidebars.product2_sidebar.entries %}
{% endif %}
{% endif %}{% endraw %}
```
Add your own condition here that points to your sidebar.
@ -377,7 +372,7 @@ javascript content here ...
```
{% endraw %}
For more detail about using `unless` in conditional logic, see {{site.data.mydoc.mydoc_urls.mydoc_conditional_logic.link}}. What this code means is "run this code unless this value is the case."
For more detail about using `unless` in conditional logic, see [Conditional logic][mydoc_conditional_logic]. What this code means is "run this code unless this value is the case."
## Overriding Bootstrap Print Styles
@ -397,3 +392,5 @@ This is problematic for code snippets that have syntax highlighting. I decided t
If you update Bootrap, make sure you make this edit. (Sorry, admittedly I couldn't figure out how to simply overwrite the `*` selector with a later style.)
I did, however, remove the color from the alerts and lighten the background shading for `pre` elements. The printstyles.css has this setting.
{% include links.html %}

5
mydoc/mydoc_git_collaboration.md → _pages/mydoc/mydoc_git_collaboration.md
View File

@ -5,7 +5,7 @@ tags: collaboration
keywords: git, github, collaboration, interaction, file sharing, push
published: false
sidebar: mydoc_sidebar
permalink: /mydoc_git_collaboration/
permalink: mydoc_git_collaboration
folder: mydoc
---
@ -180,3 +180,6 @@ From the interface, you can also create a pull request to merge all of the chang
| see what has changed since last commit | `git diff` |
| commit changes | `git commit` |
| | |
{% include links.html %}

91
mydoc/mydoc_glossary.md → _pages/mydoc/mydoc_glossary.md
View File

@ -2,10 +2,10 @@
title: Glossary layout
tags: [formatting, special_layouts]
keywords: definitions, glossaries, terms, style guide
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "Your glossary page can take advantage of definitions stored in a data file. This gives you the ability to reuse the same definition in multiple places. Additionally, you can use Bootstrap classes to arrange your definition list horizontally."
sidebar: mydoc_sidebar
permalink: /mydoc_glossary/
permalink: mydoc_glossary
toc: false
folder: mydoc
---
@ -15,53 +15,39 @@ You can create a glossary for your content. First create your glossary items in
Then create a page and use definition list formatting, like this:
```html
<dl class="dl">
fractious
: {{site.data.glossary.fractious}}
<dt id="fractious">fractious</dt>
<dd>{{site.data.glossary.fractious}}</dd>
gratuitous
: {{site.data.glossary.gratuitous}}
<dt id="gratuitous">gratuitous</dt>
<dd>{{site.data.glossary.gratuitous}}</dd>
haughty
: {{site.data.glossary.haughty}}
<dt id="haughty">haughty</dt>
<dd>{{site.data.glossary.haughty}}</dd>
gratuitous
: {{site.data.glossary.gratuitous}}
<dt id="gratuitous">gratuitous</dt>
<dd>{{site.data.glossary.gratuitous}}</dd>
impertinent
: {{site.data.glossary.intrepid}}
<dt id="impertinent">impertinent</dt>
<dd>{{site.data.glossary.impertinent}}</dd>
Here's the code:
<dt id="intrepid">intrepid</dt>
<dd>{{site.data.glossary.intrepid}}</dd>
</dl>
```
{% raw %}fractious
: {{site.data.glossary.fractious}}
Here's what that looks like:
gratuitous
: {{site.data.glossary.gratuitous}}
<dl class="dl">
haughty
: {{site.data.glossary.haughty}}
<dt id="fractious">fractious</dt>
<dd>{{site.data.glossary.fractious}}</dd>
gratuitous
: {{site.data.glossary.gratuitous}}
<dt id="gratuitous">gratuitous</dt>
<dd>{{site.data.glossary.gratuitous}}</dd>
<dt id="haughty">haughty</dt>
<dd>{{site.data.glossary.haughty}}</dd>
<dt id="benchmark_id">gratuitous</dt>
<dd>{{site.data.glossary.gratuitous}}</dd>
<dt id="impertinent">impertinent</dt>
<dd>{{site.data.glossary.impertinent}}</dd>
<dt id="intrepid">intrepid</dt>
<dd>{{site.data.glossary.intrepid}}</dd>
</dl>
impertinent
: {{site.data.glossary.intrepid}}{% endraw %}
```
The glossary works well as a link in the top navigation bar.
@ -91,6 +77,35 @@ You can also change the definition list (`dl`) class to `dl-horizontal`. This is
</dl>
For this type of list, you must use HTML. The list would then look like this:
```html
{% raw %}<dl class="dl-horizontal">
<dt id="fractious">fractious</dt>
<dd>{{site.data.glossary.fractious}}</dd>
<dt id="gratuitous">gratuitous</dt>
<dd>{{site.data.glossary.gratuitous}}</dd>
<dt id="haughty">haughty</dt>
<dd>{{site.data.glossary.haughty}}</dd>
<dt id="benchmark_id">gratuitous</dt>
<dd>{{site.data.glossary.gratuitous}}</dd>
<dt id="impertinent">impertinent</dt>
<dd>{{site.data.glossary.impertinent}}</dd>
<dt id="intrepid">intrepid</dt>
<dd>{{site.data.glossary.intrepid}}</dd>
</dl>{% endraw %}
```
If you squish your screen small enough, at a certain breakpoint this style reverts to the regular `dl` class.
Although I like the side-by-side view for shorter definitions, I found it problematic with longer definitions.
{% include links.html %}

12
mydoc/mydoc_help_api.md → _pages/mydoc/mydoc_help_api.md
View File

@ -1,11 +1,11 @@
---
title: Help APIs and UI tooltips
tags: [publishing, single_sourcing, content_types]
last_updated: March 20, 2016
last_updated: July 3, 2016
keywords: API, content API, UI text, inline help, context-sensitive help, popovers, tooltips
summary: "You can loop through files and generate a JSON file that developers can consume like a help API. Developers can pull in values from the JSON into interface elements, styling them as popovers for user interface text, for example. The beauty of this method is that the UI text remains in the help system (or at least in a single JSON file delivered to the dev team) and isn't hard-coded into the UI."
sidebar: mydoc_sidebar
permalink: /mydoc_help_api/
permalink: mydoc_help_api
folder: mydoc
---
@ -140,7 +140,7 @@ You can also view the same JSON file here: <a target="_blank" href="{{ "/tooltip
You can add different fields depending on how you want the JSON to be structured. Here we just have to fields: `id` and `body`. And the JSON is looking just in the tooltips collection that we created.
{{site.data.alerts.tip}} Check out <a href="https://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml">Google's style guide for JSON</a>. These best practices can help you keep your JSON file valid.{{site.data.alerts.end}}
{% include tip.html content="Check out [Google's style guide](https://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml) for JSON. These best practices can help you keep your JSON file valid." %}
Note that you can create different JSON files that specialize in different content. For example, suppose you have some getting started information. You could put that into a different JSON file. Using the same structure, you might add an `if` tag that checks whether the page has frontmatter that says `type: getting_started` or something. Or you could put the content into separate collection entirely (different from tooltips).
@ -203,7 +203,7 @@ In other server setups, you may need to edit one of your Apache configuration fi
If you don't have CORS enabled, users will see a CORS error/warning message in the console of the page making the request.
{{site.data.alerts.tip}} If enabling CORS is problematic, you could always just send developers the tooltips.json file and ask them to place it on their own server. {{site.data.alerts.end}}
{% include tip.html content="If enabling CORS is problematic, you could always just send developers the tooltips.json file and ask them to place it on their own server." %}
## 7. Explain how developers can access the help
@ -236,7 +236,7 @@ The `url` in the demo is relative, but you could equally point it to an absolute
The `each` method looks through all the JSON content to find the item whose `page.id` is equal to `basketball`. It then looks for an element on the page named `#basketball` and adds a `data-content` attribute to that element.
{{site.data.alerts.warning}}<b>Note:</b> Make sure your JSON file is valid. Otherwise, this method won't work. I use the <a href="https://chrome.google.com/webstore/detail/json-formatter/bcjindcccaagfpapjjmafapmmgkkhgoa?hl=en">JSON Formatter extension for Chrome</a>. When I go to the tooltips.json page in my browser, the JSON content &mdash; if valid &mdash; is nicely formatted (and includes some color coding). If the file isn't valid, it's not formatted and there isn't any color. You can also check the JSON formatting using <a href="http://jsonformatter.curiousconcept.com/">JSON Formatter and Validator</a>. If your JSON file isn't valid, identify the problem area using the validator and troubleshoot the file causing issues. It's usually due to some code that isn't escaping correctly. {{site.data.alerts.end}}
{% include warning.html content="Make sure your JSON file is valid. Otherwise, this method won't work. I use the [JSON Formatter extension for Chrome](https://chrome.google.com/webstore/detail/json-formatter/bcjindcccaagfpapjjmafapmmgkkhgoa?hl=en). When I go to the tooltips.json page in my browser, the JSON content &mdash; if valid &mdash; is nicely formatted (and includes some color coding). If the file isn't valid, it's not formatted and there isn't any color. You can also check the JSON formatting using [JSON Formatter and Validator](http://jsonformatter.curiousconcept.com/). If your JSON file isn't valid, identify the problem area using the validator and troubleshoot the file causing issues. It's usually due to some code that isn't escaping correctly." %}
Why `data-content`? Well, in this case, I'm using [Bootstrap popovers](http://getbootstrap.com/javascript/#popovers) to display the tooltip content. The `data-content` attribute is how Bootstrap injects popovers.
@ -352,3 +352,5 @@ And here's the code:
</table>
Now you have both documentation and UI tooltips generated from the same definitions file.
{% include links.html %}

93
_pages/mydoc/mydoc_hyperlinks.md Normal file
View File

@ -0,0 +1,93 @@
---
title: Links
audience: writer, designer
tags: [formatting, navigation]
keywords: links, hyperlinks, cross references, related links, relationship tables
summary: "When creating links, you can use standard HTML or Markdown formatting. Note that this approach is susceptible to errors and broken links, so check your outputs for broken links."
last_updated: July 3, 2016
sidebar: mydoc_sidebar
permalink: mydoc_hyperlinks
folder: mydoc
---
## Create an external link
When linking to an external site, use Markdown formatting because it's simplest:
```
[Google](http://google.com)
```
## Linking to internal pages
When linking to internal pages, you can manually link to the pages like this:
```
[Icons](mydoc_icons.html)
```
However, if you change the file name, you'll have to update all of your links. It's much easier to use Automated Links, as described in the next section.
## Automated links {#automatedlinks}
This method for automated links creates a master list of all links in a Markdown reference format based on entries in your sidebar table of contents.
With this Automated links method, make sure all your pages are referenced in a sidebar or topnav data file (inside \_data > sidebars). If they're not in a sidebar or top nav (such as links to headings on a page), list them in the `otherlinks.yml` file (which is in the \_data folder).
The links.html file (in \_includes) will iterate through all your sidebars and create a list of reference-style markdown links. This feature works like magic.
To implement managed links:
1. In your \_config.yml file, list each sidebar in the `sidebars` property &mdash; except for the otherlinks.yml file. (Do not list it here, since there's a different script that parses through its content.)
```yaml
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
```
2. At the bottom of each topic, include the links.html file:
```
{% raw %}{% include links.html %}{% endraw %}
```
3. To link to a topic, use reference-style Markdown links, with the referent using the file name (without the file extension). For example:
```
See the [Icon][mydoc_icons] file.
```
Here's the result:
See the [Icon][mydoc_icons] file.
If the link doesn't render, check to make sure the page is correctly listed in the sidebar.
## Automated links to headings on pages {#bookmarklinks}
If you're linking to the specific heading from another page, first give the heading an ID:
```
## Some heading {#someheading}
```
Then add a property into the otherlinks.yml file in your \_data folder:
```yaml
- title: Some link bookmark
exact_url: mydoc_pages.html#someheading
ref: mydocpages_pages-someheading
```
And reference it like this:
```
This is [Some link][mydocpages_pages-someheading].
```
{% include links.html %}

48
mydoc/mydoc_icons.md → _pages/mydoc/mydoc_icons.md
View File

@ -2,10 +2,10 @@
title: Icons
tags: [formatting]
keywords: font icons, buttons, images, vectors, font awesome, glyphicons
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can integrate font icons through the Font Awesome and Glyphical Halflings libraries. These libraries allow you to embed icons through their libraries delivered as a link reference. You don't need any image libraries downloaded in your project."
sidebar: mydoc_sidebar
permalink: /mydoc_icons/
permalink: mydoc_icons
folder: mydoc
---
@ -72,39 +72,37 @@ hr_shaded: '<hr class="shaded"/>'
This means you can insert a tip, note, warning, or important alert simply by using these tags.
{% raw %}
```liquid
{{site.data.alerts.note}} Add your note here. {{site.data.alerts.end}}
{% raw %}{% include note.html content="Add your note here." %}{% endraw %}
```
{% endraw %}
```liquid
{% raw %}{% include tip.html content="Add your tip here." %}{% endraw %}
```
```liquid
{% raw %}{% include important.html content="Add your important info here." %}{% endraw %}
```
{% raw %}
```liquid
{{site.data.alerts.tip}} Add your tip here. {{site.data.alerts.end}}
```
{% endraw %}
{% raw %}
```liquid
{{site.data.alerts.important}} Add your important info here. {{site.data.alerts.end}}
```
{% endraw %}
{% raw %}
```liquid
{{site.data.alerts.warning}} Add your warning here. {{site.data.alerts.end}}
{% include warning.html content="Add your warning here." %}
```
{% endraw %}
Here's the result:
{{site.data.alerts.note}} Add your note here. {{site.data.alerts.end}}
{% include note.html content="Add your note here." %}
{{site.data.alerts.tip}} Here's my tip. {{site.data.alerts.end}}
{% include tip.html content="Here's my tip." %}
{{site.data.alerts.important}} This information is very important.{{site.data.alerts.end}}
{% include important.html content="This information is very important." %}
{{site.data.alerts.warning}} If you overlook this, you may die. {{site.data.alerts.end}}
{% include warning.html content="If you overlook this, you may die." %}
The color scheme is the default colors from Bootstrap. You can modify the icons or colors as needed.
@ -201,13 +199,13 @@ And here's the shortcode:
{% raw %}
```
{{site.data.alerts.callout_info}This is a special callout information message. {{site.data.alerts.end}}
{{site.data.alerts.callout_info}This is a special callout information message.
{% endraw %}
```
Here's the result:
{{site.data.alerts.callout_info}}This is a special callout information message. {{site.data.alerts.end}}
{{site.data.alerts.callout_info}}This is a special callout information message.
You can use any of the following:
{% raw %}
@ -223,3 +221,5 @@ You can use any of the following:
The only difference is the color of the left bar.
Callouts are explained in a bit more detail in <a href="{{ "/mydoc_alerts" | prepend: site.baseurl }}">Alerts</a>.
{% include links.html %}

25
mydoc/mydoc_images.md → _pages/mydoc/mydoc_images.md
View File

@ -2,10 +2,10 @@
title: Images
tags: [formatting]
keywords: images, screenshots, vectors, svg, markdown syntax
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "Store images in the images folder and use the image.html include to insert images. This include has several options, including figcaptions, that extract the content from the formatting."
sidebar: mydoc_sidebar
permalink: /mydoc_images/
permalink: mydoc_images
folder: mydoc
---
@ -35,6 +35,25 @@ Here's the result:
{% include image.html file="jekyll.png" url="http://jekyllrb.com" alt="Jekyll" caption="This is a sample caption" %}
## Inline image includes
For inline images, such as with a button that you want to appear inline with text, use the inline_image.html include, like this:
```liquid
Click the **Android SDK Manager** button {%raw%}{% include inline_image.html
file="androidsdkmanagericon" type="png" alt="SDK button" %}{%endraw%}
```
Click the **Android SDK Manager** button {% include inline_image.html file="androidsdkmanagericon" type="png" alt="SDK button" %}
The inline_image.html include properties are as follows:
| Property | description |
|-------|--------|
| file | The name of the file |
| type | The type of file (png, svg, and so on) |
| alt | Alternative image text for accessibility and SEO |
## SVG Images
You can also embed SVG graphics. If you use SVG, you need to use the HTML syntax so that you can define a width/container for the graphic. Here's a sample embed:
@ -74,3 +93,5 @@ Also, if you're working with SVG graphics, note that Firefox does not support SV
Also, remove the check box for "Use textpath element for text on a path". And select "Embed" rather than "Link." The following screenshot shows the settings I use. Your graphics will look great in Firefox.
![Essential options for SVG with Illustrator]({{ "/images/illustratoroptions.png" | prepend: site.baseurl }})
{% include links.html %}

6
mydoc/mydoc_install_jekyll_on_mac.md → _pages/mydoc/mydoc_install_jekyll_on_mac.md
View File

@ -4,7 +4,7 @@ tags: [getting_started, troubleshooting]
keywords:
summary: "Installation of Jekyll on Mac is usually less problematic than on Windows. However, you may run into permissions issues with Ruby that you must overcome. You should also use Bundler to be sure that you have all the required gems and other utilities on your computer to make the project run. "
sidebar: mydoc_sidebar
permalink: /mydoc_install_jekyll_on_mac/
permalink: mydoc_install_jekyll_on_mac
folder: mydoc
---
@ -101,7 +101,7 @@ gem install bundler
If you're prompted to switch to superuser mode (`sudo`) to get the correct permissions to install Bundler in that directory, avoid doing this. All other applications that need to use Bundler will likely not have the needed permissions to run.
Bundler goes out and retreives all the gems that are specified in a Jekyll project's Gemfile. If you have a gem that depends on other gems to work, Bundler will go out and retrieve all of the dependencies as well. (To learn more about Bundler, see {{site.data.urls.mydoc_about_ruby_gems_etc.link}}.
Bundler goes out and retreives all the gems that are specified in a Jekyll project's Gemfile. If you have a gem that depends on other gems to work, Bundler will go out and retrieve all of the dependencies as well. (To learn more about Bundler, see [About Ruby Gems][mydoc_about_ruby_gems_etc].
The vanilla Jekyll site you create through `jekyll new my-awesome-site` doesn't have a Gemfile, but many other themes (including the Documentation theme for Jekyll) do have a Gemfile.
@ -110,3 +110,5 @@ The vanilla Jekyll site you create through `jekyll new my-awesome-site` doesn't
1. Browse to the directory where you downloaded the Documentation theme for Jekyll.
2. Type `jekyll serve`
3. Go to the preview address in the browser. (Make sure you include the `/` at the end.)
{% include links.html %}

10
mydoc/mydoc_install_jekyll_on_windows.md → _pages/mydoc/mydoc_install_jekyll_on_windows.md
View File

@ -1,12 +1,12 @@
---
title: Install Jekyll on Windows
permalink: /mydoc_install_jekyll_on_windows/
permalink: mydoc_install_jekyll_on_windows
keywords: jekyll on windows, pc, ruby, ruby dev kit
sidebar: mydoc_sidebar
folder: mydoc
---
{{site.data.alerts.tip}} For a better terminal emulator on Windows, use [Git Bash](https://git-for-windows.github.io/). Git Bash gives you Linux-like control on Windows. {{site.data.alerts.end}}
{% include tip.html content="For a better terminal emulator on Windows, use [Git Bash](https://git-for-windows.github.io/). Git Bash gives you Linux-like control on Windows." %}
## Install Ruby
@ -80,6 +80,10 @@ You install Bundler by using the gem command with RubyGems:
Bundle retrieves all the needed gems and gem dependencies and downloads them to your computer. At this time, Bundle also takes a snapshot of all the gems used in your project and creates a Gemfile.lock file to store this information.
## Git Clients for Windows
Although you can use the default command prompt with Windows, it's recommended that you use [Git Bash](https://git-for-windows.github.io/) instead. The Git Bash client will allow you to run shell scripts and execute other Unix commands.
## Serve the Jekyll Documentation theme
1. Browse to the directory where you downloaded the Documentation theme for Jekyll.
@ -87,3 +91,5 @@ You install Bundler by using the gem command with RubyGems:
3. Go to the preview address in the browser. (Make sure you include the `/` at the end.)
Unfortunately, the Command Prompt doesn't allow you to easily copy and paste the URL, so you'll have to type it manually.
{% include links.html %}

4
mydoc/mydoc_installing_bundler.md → _pages/mydoc/mydoc_installing_bundler.md
View File

@ -2,7 +2,7 @@
title: Installing Bundler
published: false
sidebar: mydoc_sidebar
permalink: /mydoc_installing_bundler/
permalink: mydoc_installing_bundler
folder: mydoc
---
@ -39,3 +39,5 @@ bundle install
Execute Bundler against your project:
bundle exec jekyll serve
(Instead of jekyll serve, run one of the other build commands.)
{% include links.html %}

6
mydoc/mydoc_introduction.md → _pages/mydoc/mydoc_introduction.md
View File

@ -1,7 +1,7 @@
---
title: Introduction
sidebar: mydoc_sidebar
permalink: /mydoc_introduction/
permalink: mydoc_introduction
folder: mydoc
---
@ -25,4 +25,6 @@ Some of the more prominent features of this theme include the following:
## Getting started
To get started, see <a href="{{ "/mydoc_getting_started" | prepend: site.baseurl }}">Get started</a>.
To get started, see [Getting Started][home].
{% include links.html %}

8
mydoc/mydoc_iterm_profiles.md → _pages/mydoc/mydoc_iterm_profiles.md
View File

@ -2,10 +2,10 @@
title: iTerm profiles
tags: [publishing]
keywords: iterm, terminal, build shortcuts, mac
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can set up profiles in iTerm to facilitate the build process with just a few clicks. This can make it a lot easier to quickly build multiple outputs."
sidebar: mydoc_sidebar
permalink: /mydoc_iterm_profiles/
permalink: mydoc_iterm_profiles
folder: mydoc
---
@ -38,4 +38,6 @@ Here's an example:
1. In iTerm, make sure the Toolbar is shown. Go to **View > Toggle Toolbar**.
2. Click the **New** button and select your profile.
{{site.data.alerts.tip}} When you're done with the session, make sure to click <b>Ctrl+C</b>.{{site.data.alerts.end}}
{% include tip.html content="When you're done with the session, make sure to click <b>Ctrl+C</b>." %}
{% include links.html %}

6
mydoc/mydoc_kb_layout.md → _pages/mydoc/mydoc_kb_layout.md
View File

@ -2,10 +2,10 @@
title: Knowledge-base layout
tags: [special_layouts]
keywords: knowledge base, support portal, grid, doc portal
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "This shows a sample layout for a knowledge base. Each square could link to a tag archive page. In this example, font icons from Font Awesome are used for the graphics, and the layout is pulled from the Modern Business theme. ."
sidebar: mydoc_sidebar
permalink: /mydoc_kb_layout/
permalink: mydoc_kb_layout
toc: false
folder: mydoc
---
@ -111,3 +111,5 @@ Getting started pages:
{% endfor %}
{% endfor %}
</ul>
{% include links.html %}

6
mydoc/mydoc_labels.md → _pages/mydoc/mydoc_labels.md
View File

@ -2,10 +2,10 @@
title: Labels
tags: [formatting]
keywords: labels, buttons, bootstrap, api methods
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "Labels are just a simple Bootstrap component that you can include in your pages as needed. They represent one of many Bootstrap options you can include in your theme."
sidebar: mydoc_sidebar
permalink: /mydoc_labels/
permalink: mydoc_labels
folder: mydoc
---
@ -29,3 +29,5 @@ Labels might come in handy for adding button-like tags next to elements, such as
<span class="label label-danger">Danger</span>
You can have a label appear within a heading simply by including the span tag in the heading. However, you can't mix Markdown syntax with HTML, so you'd have to hard-code the heading ID for the auto-TOC to work.
{% include links.html %}

133
_pages/mydoc/mydoc_lists.md Normal file
View File

@ -0,0 +1,133 @@
---
title: Lists
keywords: bulleted lists, numbered lists
tags: [formatting]
summary: "This page shows how to create both bulleted and numbered lists"
sidebar: mydoc_sidebar
permalink: mydoc_lists
---
## Bulleted Lists
This is a bulleted list:
```
* first item
* second item
* third item
```
**Result:**
* first item
* second item
* third item
## Numbered list
This is a simple numbered list:
```
1. First item.
1. Second item.
1. Third item.
```
**Result:**
1. First item.
1. Second item.
1. Third item.
You can use whatever numbers you want &mdash; when the Markdown filter processes the content, it will assign the correct numbers to the list items.
## Complex Lists
Here's a more complex list:
```
1. Sample first item.
* sub-bullet one
* sub-bullet two
2. Continuing the list
1. sub-list numbered one
2. sub-list numbered two
3. Another list item.
```
**Result:**
1. Sample first item.
* sub-bullet one
* sub-bullet two
2. Continuing the list
1. sub-list numbered one
2. sub-list numbered two
3. Another list item.
## Another Complex List
Here's a list with some intercepting text:
```
1. Sample first item.
This is a result statement that talks about something....
2. Continuing the list
{% include note.html content="Remember to do this. If you have \"quotes\", you must escape them." %}
Here's a list in here:
* first item
* second item
3. Another list item.
```js
function alert("hello");
```
4. Another item.
```
**Result:**
1. Sample first item.
This is a result statement that talks about something....
2. Continuing the list
{% include note.html content="Remember to do this. If you have \"quotes\", you must escape them." %}
Here's a list in here:
* first item
* second item
3. Another list item.
```js
function alert("hello");
```
4. Another item.
### Key Principle to Remember with Lists
The key principle is to line up the first character after the dot following the number:
{% include image.html file="liningup" type="png" caption="Lining up the left edge ensures the list stays in tact." %}
For the sake of simplicity, use two spaces after the dot for numbers 1 through 9. Use one space for numbers 10 and up. If any part of your list doesn't align symmetrically on this left edge, the list will not render correctly. Also note that this is characteristic of kramdown-flavored Markdown and may not yield the same results in other Markdown flavors.

6
mydoc/mydoc_navtabs.md → _pages/mydoc/mydoc_navtabs.md
View File

@ -2,10 +2,10 @@
title: Navtabs
tags: [formatting]
keywords: navigation tabs, hide sections, tabbers, interface tabs
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "Navtabs provide a tab-based navagation directly in your content, allowing users to click from tab to tab to see different panels of content. Navtabs are especially helpful for showing code samples for different programming languages. The only downside to using navtabs is that you must use HTML instead of Markdown."
sidebar: mydoc_sidebar
permalink: /mydoc_navtabs/
permalink: mydoc_navtabs
folder: mydoc
---
@ -102,3 +102,5 @@ By setting a cookie, if the user refreshes the page, the active tab is the tab t
## Functionality to implement
One piece of functionality I'd like to implement is the ability to set site-wide nav tab options. For example, if the user always chooses PHP instead of Java in the code samples, it would be great to set this option site-wide by default. However, this functionality isn't yet coded.
{% include links.html %}

4
mydoc/mydoc_no_password_prompts_scp.md → _pages/mydoc/mydoc_no_password_prompts_scp.md
View File

@ -2,7 +2,7 @@
title: Getting around the password prompts in SCP
sidebar: mydoc_sidebar
tags: [publishing, troubleshooting]
permalink: /mydoc_no_password_prompts_scp/
permalink: mydoc_no_password_prompts_scp
summary: "You can publish your docs via SSH through a Terminal window or more likely, via a shell script that you simply execute as part of the publishing process. However, you will be prompted for your password with each file transfer unless you configure passwordless SSH. The basic process for setting up password less SSH is to create a key on your own machine that you also transfer to the remote machine. When you use the SCP command, the remote machine checks that you have the authorized key and allows access without a password prompt."
folder: mydoc
---
@ -128,3 +128,5 @@ To remove the password prompts when connecting to servers via SSH:
```
scp -r ../doc_outputs/mydoc/writers <your-username>@remoteserver:/var/www/html/
```
{% include links.html %}

101
mydoc/mydoc_pages.md → _pages/mydoc/mydoc_pages.md
View File

@ -2,48 +2,47 @@
title: Pages
tags: [getting_started, formatting, content_types]
keywords: pages, authoring, exclusion, frontmatter
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "This theme primarily uses pages. You need to make sure your pages have the appropriate frontmatter. One frontmatter tag your users might find helpful is the summary tag. This functions similar in purpose to the shortdesc element in DITA."
sidebar: mydoc_sidebar
permalink: /mydoc_pages/
permalink: mydoc_pages
folder: mydoc
---
## Where to author content
Use a text editor such as Sublime Text, WebStorm, IntelliJ, or Atom to create pages.
My preference is IntelliJ/WebStorm, since it will treat all files in your theme as belonging to a project. This allows you to easily search for instances of keywords, do find-and-replace operations, or do other actions that apply across the whole project.
Use a text editor such as Sublime Text, WebStorm, IntelliJ, or Atom to create pages. Atom is recommended because it's created by Github, which is driving some of the Jekyll development through Github Pages.
## Page names and excluding files from outputs
By default, everything in your project is included in the output. You can exclude all files that don't belong to that project by specifying the file name, the folder name, or by using wildcards in your configuration file:
```yaml
exclude:
- filename.md
- subfolder_name/
- mydoc_*
- gitignore
```
These wildcards will exclude every match after the `*`.
Wildcards will exclude every match after the `*`.
## Frontmatter
Make sure each page has frontmatter at the top like this:
{% raw %}
```yaml
---
title: Alerts
tags: [formatting]
keywords: notes, tips, cautions, warnings, admonitions
last_updated: March 20, 2016
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes are stored as shortcodes made available through the linksrefs.hmtl include."
last_updated: July 3, 2016
summary: "You can insert notes, tips, warnings, and important alerts in your content."
sidebar: mydoc_sidebar
permalink: /mydoc_alerts/
permalink: mydoc_alerts
---
{% endraw %}
Frontmatter is always formatted with three hyphens at the top and bottom. Your frontmatter must have a `title` value. All the other values are optional. If you omit them, the theme won't break.
Frontmatter is always formatted with three hyphens at the top and bottom. Your frontmatter must have a `title` and `permalink` value. All the other values are optional.
Note that you cannot use variables in frontmatter.
@ -56,7 +55,7 @@ The following table describes each of the frontmatter that you can use with this
| **keywords** | Optional | Synonyms and other keywords for the page. This information gets stuffed into the page's metadata to increase SEO. The user won't see the keywords, but if you search for one of the keywords, it will be picked up by the search engine. |
| **last_updated** | Optional | The date the page was last updated. This information could helpful for readers trying to evaluate how current and authoritative information is. If included, the last_updated date appears in the footer of the page in rather small font.|
| **summary** | Optional | A 1-2 word sentence summarizing the content on the page. This gets formatted into the summary section in the page layout. Adding summaries is a key way to make your content more scannable by users (check out [Jakob Nielsen's site](http://www.nngroup.com/articles/corporate-blogs-front-page-structure/) for a great example of page summaries.) The only drawback with summaries is that you can't use variables in them. |
| **permalink**| Required | This theme uses permalinks to facilitate the linking. You specify the permalink want for the page, and the \_site output will put the page into the root directory when you publish. The page will appear inside a folder by the same name, with the actual page being index.html. Browsers will automatically show the index.html file inside of any folder, so permalinks avoid the .html extension with file names. Permalink names don't have to match your file names, but it might be easier to keep them in sync. If you don't use permalinks, Jekyll automatically uses the file name and folder path as the link.|
| **permalink**| Required | Make the permalink match the file name for the sake of simplicity. You specify the permalink you want for the page, and the \_site output will put the page into the root directory when you publish. Permalink names don't have to match your file names, but it might be easier to keep them in sync. If you don't use permalinks, Jekyll automatically uses the file name and folder path as the link.|
| **datatable** | Optional | 'true'. If you add `datatable: true` in the frontmatter, scripts for the [jQuery Datatables plugin](https://www.datatables.net/) get included on the page. You can see the scripts that conditionally appear by looking in the \_layouts/default.html page. |
| toc | Optional | If you specify `toc: false` in the frontmatter, the page won't have the table of contents that appears below the title. The toc refers to the list of jump links below the page title, not the sidebar navigation. You probably want to hide the TOC on the homepage and product landing pages.|
@ -68,15 +67,15 @@ If you want to use a colon in your page title, you must enclose the title's valu
If you add `published: false` in the frontmatter, your page won't be published. You can also move draft pages into the \_drafts folder to exclude them from the build. With posts, you can also keep them as drafts by omitting the date in the title.
{{site.data.alerts.tip}} You can create file templates in WebStorm that have all your common frontmatter, such as all possible tags, prepopulated. See <a href="{{ "/mydoc_webstorm_text_editor" | prepend: site.baseurl }}">WebStorm Text Editor</a> for details. {{site.data.alerts.end}}
## Markdown or HTML format
Pages can be either Markdown or HTML format (specified through either an .md or .html file extension).
If you use Markdown, you can also include HTML formatting where needed. But not vice versa &mdash; if you use HTML (as your file extension), you can't insert Markdown content in the file.
If you use Markdown, you can also include HTML formatting where needed. But if you're format is HTML, you must add a `markdown="1"` attribute to the element:
Also, if you use HTML inside a Markdown file, you cannot use Markdown inside of HTML. But you can use HTML inside of Markdown.
```
<div markdown="1">This is a [link](http://exmaple.com).</div>
```
For your Markdown files, note that a space or two indent will set text off as code or blocks, so avoid spacing indents unless intentional.
@ -86,9 +85,19 @@ If you have a lot of HTML, as long as the top and bottom tags of the HTML are fl
You can store your pages in any folder structures you want, with any level of folder nesting. The site output will pull all of those pages out of their folders and put them into the root directory. Check out the \_site folder, which is where Jekyll is generated, to see the difference between your project's structure and the resulting site output.
The listing of all pages in the root directory is what allows the relative linking and offline viewing of the site to work.
## Site suffixes
By default, URLs won't show the ".html" in the page name. However, if you want this, add the following in your configuration file:
```
suffix: .html
```
## Page names
I recommend prefixing your page names with the product, such as "mydoc_pages" instead of just "pages." This way if you have other products that also hae topics with generic names such as "pages," there won't be naming conflicts.
I recommend prefixing your page names with the product, such as "mydoc_pages" instead of just "pages." This way if you have other products that also have topics with generic names such as "pages," there won't be naming conflicts.
Additionally, consider adding the product name in parentheses after the title, such as "Pages (Mydoc)" so that users can clearly navigate different topics for each product.
@ -114,6 +123,53 @@ By default, a TOC appears at the top of your pages and posts. If you don't want
The mini-TOC requires you to use the `##` Markdown syntax for headings. If you use `<h2>` elements, you must add an ID attribute for the heading element in order for it to appear in the mini-TOC (for example, `<h2 id="mysampleid">Heading</h2>`.
## Headings
Use pound signs before the heading title to designate the level. Note that kramdown requires headings to have one space before and after the heading.
```
## Second-level heading
```
## Second-level heading
-----
```
### Third-level heading
```
### Third-level heading
------
```
#### Fourth-level heading
```
#### Fourth-level heading
## Headings with ID Tags {#someIdTag}
If you want to use a specific ID tag with your heading, add it like this:
```
## Headings with ID Tags {#someIdTag}
```
Then you can reference it with a link like this on the same page:
```
[Some link](#someIdTag)
```
**Result:**
[Some link](#someIdTag)
For details about linking to headings on pages using automated links, see [Automated links to headings on pages][mydoc_hyperlinks-bookmarklinks].
## Specify a particular page layout
The configuration file sets the default layout for pages as the "page" layout.
@ -124,11 +180,4 @@ You can create other layouts inside the layouts folder. If you create a new layo
Disqus, a commenting system, is integrated into the theme. In the configuration file, specify the Disqus code for the universal code, and Disqus will appear. If you don't add a Disqus value, the Disqus form isn't included.
## Custom keyboard shortcuts
Some of the Jekyll syntax can be slow to create. Using a utility such as [aText](https://www.trankynam.com/atext/) can make creating content a lot of faster.
For example, with my aText configuration, when I type `jlink`, aText replaces it with {% raw %}`<a href="{{ "/page" | prepend: site.baseurl }}">page</a>`{% endraw %}.
You get aText from the App Store on a Mac for about $5. However, the Mac Store version of aText won't work on Mac OSX El Capitan due to sandbox security restrictions, so you need to download the app outside of the App Store to make it work.
There are alternatives to aText, such as Typeitforme. But aText seems to work the best. You can read more about aText on [Lifehacker](http://lifehacker.com/5843903/the-best-text-expansion-app-for-mac).
{% include links.html %}

7
mydoc/mydoc_posts.md → _pages/mydoc/mydoc_posts.md
View File

@ -5,7 +5,7 @@ keywords: posts, blog, news, authoring, exclusion, frontmatter
last_updated: Feb 25, 2016
summary: "You can use posts when you want to create blogs or news type of content."
sidebar: mydoc_sidebar
permalink: /mydoc_posts/
permalink: mydoc_posts
folder: mydoc
---
@ -28,7 +28,7 @@ title: My sample post
keywords: pages, authoring, exclusion, frontmatter
summary: "This is some summary frontmatter for my sample post."
sidebar: mydoc_sidebar
permalink: /mydoc_pages/
permalink: mydoc_pages/
tags: content_types
---
@ -40,3 +40,6 @@ tags: content_types
| **keywords** | Optional | Synonyms and other keywords for the page. This information gets stuffed into the page's metadata to increase SEO. The user won't see the keywords, but if you search for one of the keywords, it will be picked up by the search engine. |
| **summary** | Optional | A 1-2 word sentence summarizing the content on the page. This gets formatted into the summary section in the page layout. Adding summaries is a key way to make your content more scannable by users (check out [Jakob Nielsen's site](http://www.nngroup.com/articles/corporate-blogs-front-page-structure/) for a great example of page summaries.) The only drawback with summaries is that you can't use variables in them. |
| **permalink**| Required | This theme uses permalinks to facilitate the linking. You specify the permalink want for the page, and the \_site output will put the page into the root directory when you publish. The page will appear inside a folder by the same name, with the actual page being index.html. Browsers will automatically show the index.html file inside of any folder, so permalinks avoid the .html extension with file names. Permalink names don't have to match your file names, but it might be easier to keep them in sync. |
{% include links.html %}

6
mydoc/mydoc_publishing_github_pages.md → _pages/mydoc/mydoc_publishing_github_pages.md
View File

@ -1,7 +1,7 @@
---
title: Publishing on Github Pages
sidebar: mydoc_sidebar
permalink: /mydoc_publishing_github_pages/
permalink: mydoc_publishing_github_pages
summary: "You can publish your project on Github Pages, which is a free web hosting service provided by Github. All you need is to put your content into a Github repo branch called gh-pages and make this your default branch in your repo. With a Jekyll site, you just commit your entire project into the gh-pages branch and Github Pages will build the site for you."
folder: mydoc
---
@ -23,7 +23,7 @@ folder: mydoc
11. Go back to your repository's homepage. With the gh-pages branch selected, copy the **https clone url**:
12. Open a terminal, browse to a convenient location for your project, and type `git clone https://github.com/tomjohnson1492/myreponame.git`, replacing the `https://github.com/tomjohnson1492/myreponame.git` with your repository's https clone URL that you copied.
13. Move the jekyll theme files into this new folder that you just created in the previous step.
14. Open the _config.yml file and add the following:
14. Open the \_config.yml file and add the following:
```
url: tomjohnson1492.github.io
@ -70,3 +70,5 @@ Github Pages will now automatically build your site. Wait a minute or two, and t
## Customize your URL
You can also customize your Github URL. More instructions on this later....
{% include links.html %}

6
mydoc/mydoc_push_build_to_server.md → _pages/mydoc/mydoc_push_build_to_server.md
View File

@ -2,10 +2,10 @@
title: Pushing builds to server
tags: [publishing]
keywords: AWS, Amazon, command line, pushing build
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can push your build to AWS using commands from the command line. By including your copy commands in commands, you can package all of the build and deploy process into executable scripts."
sidebar: mydoc_sidebar
permalink: /mydoc_push_build_to_server/
permalink: mydoc_push_build_to_server
folder: mydoc
---
@ -31,3 +31,5 @@ scp -r /users/tjohnson/projects/mydocproject/ name@domain:/var/www/html/mydocpro
```
Similar to the above, the first path is the local location; the second path is the destination.
{% include links.html %}

6
mydoc/mydoc_release_notes_50.md → _pages/mydoc/mydoc_release_notes_50.md
View File

@ -2,10 +2,10 @@
title: Release notes 5.0
tags: [getting_started]
keywords: release notes, announcements, what's new, new features
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "Version 5.0 of the Documentation theme for Jekyll changes some fundamental ways the theme works to provide product-specific sidebars, intended to accommodate a site where multiple products are grouped together on the same site rather than generated out as separate outputs."
sidebar: mydoc_sidebar
permalink: /mydoc_release_notes_50/
permalink: mydoc_release_notes_50
folder: mydoc
---
@ -44,3 +44,5 @@ Previously I had some errors with the HTML that showed up in w3c HTML validator
## Accessing the old theme
If you want to access the old theme, you can still find it [here](https://github.com/tomjohnson1492/jekylldoctheme-separate-outputs).
{% include links.html %}

37
_pages/mydoc/mydoc_release_notes_60.md Normal file
View File

@ -0,0 +1,37 @@
---
title: Release notes 6.0
tags: [getting_started]
keywords: release notes, announcements, what's new, new features
last_updated: July 3, 2016
summary: "Version 6.0 of the Documentation theme for Jekyll, released July 4, 2016, implements relative links so you can view the files offline or on any server without configuring urls and baseurls. Additionally, you can store pages in subdirectories. Templates for alerts and images are available."
sidebar: mydoc_sidebar
permalink: mydoc_release_notes_60
folder: mydoc
---
## Relative links
You can now view the site offline rather than solely through the Jekyll preview server or deployed on a web server. The linking approach in both the sidebar and with inline links uses relative linking throughout.
## Subfolders for pages
You can creates folders and subfolders for your pages, similar to how you can store posts in folders and subfolders. When Jekyll builds the site, all pages get pushed into the root directory as single html files (rather than being pushed inside folders, or remaining in subfolders). See [Pages][mydoc_pages] for more details.
## Alerts templates
You can use include templates for notes, tips, and warnings. These include templates make it easier to insert notes. If you make an error, you're immediately made aware since the site won't build. See [Alerts][mydoc_alerts] for more details.
## Image templates
Similar to alerts, images also have include templates. You can insert both regular images and inline images, such as images that are a button or icon. See [Images][mydoc_images] for more details.
## Automated links using Markdown formatting
Instead of using YAML references to handle links, I've switched to a Markdown reference style approach. A links.html file iterates through the sidebar files and formats the content in the Markdown reference. You then just use Markdown syntax for the links. See [Links][mydoc_hyperlinks] for more details.
## Workflow maps
If you want to display a workflow map for a process, you can do so by adding some properties in your frontmatter. The workflow map helps guide users through a process. Both simple and complex workflow maps are available. For more details, see [Workflow maps][mydoc_workflow_maps].
{% include links.html %}

8
mydoc/mydoc_search_configuration.md → _pages/mydoc/mydoc_search_configuration.md
View File

@ -2,10 +2,10 @@
title: Search configuration
tags: [publishing, navigation]
keywords: search, json, configuration, findability
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "The search feature uses JavaScript to look for keyword matches in a JSON file. The results show instant matches, but it doesn't provide a search results page like Google. Also, sometimes invalid formatting can break the JSON file."
sidebar: mydoc_sidebar
permalink: /mydoc_search_configuration/
permalink: mydoc_search_configuration
folder: mydoc
---
@ -93,7 +93,7 @@ The \_includes/topnav.html file then makes use of these values:
<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" | prepend: site.baseurl }}" 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'),
@ -114,3 +114,5 @@ Where you see `{url}` and `{title}`, the search is retrieving the values for the
## More robust search
For more robust search, consider integrating either [Algolia](http://algolia.com) or [Swifttype](http://swiftype.com).
{% include links.html %}

8
mydoc/mydoc_series.md → _pages/mydoc/mydoc_series.md
View File

@ -2,10 +2,10 @@
title: Series
tags: [content_types]
keywords: series, connected articles, tutorials, hello world
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can automatically link together topics belonging to the same series. This helps users know the context within a particular process."
sidebar: mydoc_sidebar
permalink: /mydoc_series/
permalink: mydoc_series
folder: mydoc
---
@ -45,7 +45,7 @@ Change "ACME series" to the name of your series.
Save this in your \_includes/custom folder as something like series\_acme.html.
{{site.data.alerts.warning}} With pages, there isn't a universal namespace created from tags or categories like there is with Jekyll posts. As a result, you have to loop through all pages. If you have a lot of pages in your site (e.g., 1,000+), then this looping will create a slow build time. If this is the case, you will need to rethink the approach to looping here.{{site.data.alerts.end}}
{% include warning.html content="With pages, there isn't a universal namespace created from tags or categories like there is with Jekyll posts. As a result, you have to loop through all pages. If you have a lot of pages in your site (e.g., 1,000+), then this looping will create a slow build time. If this is the case, you will need to rethink the approach to looping here." %}
## 2. Create the "next" include
@ -106,3 +106,5 @@ The Bootstrap menu uses the `primary` class for styling. If you change this clas
## Using a collection with your series
Instead of copying and pasting the button includes on each of your series, you could also create a collection and define a layout for the collection that has the include code. For more information on creating collections, see <a href="{{ "/mydoc_collections" | prepend: site.baseurl }}">Collections</a>.
{% include links.html %}

6
mydoc/mydoc_seriesdemo1.md → _pages/mydoc/mydoc_seriesdemo1.md
View File

@ -3,9 +3,9 @@ title: Series demo 1
summary: "This is the first post in the series."
series: "ACME series"
weight: 1
last_updated: March 20, 2016
last_updated: July 3, 2016
sidebar: mydoc_sidebar
permalink: /mydoc_seriesdemo1/
permalink: mydoc_seriesdemo1
folder: mydoc
---
@ -18,3 +18,5 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudi
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus.
{% include custom/series_acme_next.html %}
{% include links.html %}

6
mydoc/mydoc_seriesdemo2.md → _pages/mydoc/mydoc_seriesdemo2.md
View File

@ -3,9 +3,9 @@ title: Series demo 2
summary: "This is the second post in the series."
series: "ACME series"
weight: 2
last_updated: March 20, 2016
last_updated: July 3, 2016
sidebar: mydoc_sidebar
permalink: /mydoc_seriesdemo2/
permalink: mydoc_seriesdemo2
folder: mydoc
---
@ -21,3 +21,5 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudi
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo.
{% include custom/series_acme_next.html %}
{% include links.html %}

6
mydoc/mydoc_seriesdemo3.md → _pages/mydoc/mydoc_seriesdemo3.md
View File

@ -4,9 +4,9 @@ last_updated: May 17, 2016
summary: "This is the third post in the series."
series: "ACME series"
weight: 3
last_updated: March 20, 2016
last_updated: July 3, 2016
sidebar: mydoc_sidebar
permalink: /mydoc_seriesdemo3/
permalink: mydoc_seriesdemo3
folder: mydoc
---
@ -21,3 +21,5 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudi
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus.
{% include custom/series_acme_next.html %}
{% include links.html %}

6
mydoc/mydoc_seriesdemo4.md → _pages/mydoc/mydoc_seriesdemo4.md
View File

@ -3,9 +3,9 @@ title: Series demo 4
summary: "This is the fourth post in the series."
series: "ACME series"
weight: 4
last_updated: March 20, 2016
last_updated: July 3, 2016
sidebar: mydoc_sidebar
permalink: /mydoc_seriesdemo4/
permalink: mydoc_seriesdemo4
folder: mydoc
---
@ -25,3 +25,5 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudi
{% include custom/series_acme_next.html %}
{% include links.html %}

8
mydoc/mydoc_sidebar_navigation.md → _pages/mydoc/mydoc_sidebar_navigation.md
View File

@ -1,11 +1,11 @@
---
title: Sidebar Navigation
tags: [getting_started]
last_updated: March 20, 2016
last_updated: July 3, 2016
keywords: sidebar, accordion, yaml, iteration, for loop, navigation, attributes, conditional filtering
summary: "The sidebar navigation uses a jQuery component called Navgoco. The sidebar is a somewhat complex part of the theme that remembers your current page, highlights the active item, stays in a fixed position on the page, and more. This page explains a bit about how the sidebar was put together."
sidebar: mydoc_sidebar
permalink: /mydoc_sidebar_navigation/
permalink: mydoc_sidebar_navigation
folder: mydoc
---
@ -21,7 +21,7 @@ In short, the sidebar has some complex logic here. I've integrated Navgoco's fea
## Accordion sidebar feature
The sidebar.html file (inside the _includes folder) contains the `.navgoco` method called on the `#mysidebar` element.
The sidebar.html file (inside the \_includes folder) contains the `.navgoco` method called on the `#mysidebar` element.
There are some options to set within the `.navgoco` method. The only noteworthy option is `accordion`. This option makes it so when you expand a section, the other sections collapse. It's a way of keeping your navigation controls condensed.
@ -80,3 +80,5 @@ This is why the `url` value in the sidebar data file looks something like this:
Note that the url does not include the project folder where the file is stored. This is because the site uses permalinks, which pulls the topics out of subfolders and places them into the root directory when the site builds.
Now the page.url and the item.url can match and the `active` class can get applied. With the `active` class applied, the sidebar section remains open.
{% include links.html %}

8
mydoc/mydoc_special_layouts.md → _pages/mydoc/mydoc_special_layouts.md
View File

@ -2,15 +2,15 @@
title: Special layouts overview
tags: [special_layouts]
keywords: layouts, information design, presentation
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site."
sidebar: mydoc_sidebar
permalink: /mydoc_special_layouts/
permalink: mydoc_special_layouts
folder: mydoc
---
{{site.data.alerts.note}} By "layout," I'm not referring to the layouts in \_layouts in the project files. I'm referring to special ways of presenting information on the same "page" layout. {{site.data.alerts.end}}
{% include note.html content="By \"layout,\" I'm not referring to the layouts in \_layouts in the project files. I'm referring to special ways of presenting information on the same \"page\" layout." %}
## FAQ layout
@ -27,3 +27,5 @@ If you have a long JSON message you're documenting, see the {{site.data.mydoc_ur
## Shuffle layout
If you want a dynamic card layout that allows you to filter the cards, see {{site.data.mydoc_urls.mydoc_shuffle.link}}. This uses the Shuffle JS library.
{% include links.html %}

6
mydoc/mydoc_support.md → _pages/mydoc/mydoc_support.md
View File

@ -2,11 +2,13 @@
title: Support
tags: [getting_started, troubleshooting]
keywords: questions, troubleshooting, contact, support
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "Contact me for any support issues."
sidebar: mydoc_sidebar
permalink: /mydoc_support/
permalink: mydoc_support
folder: mydoc
---
Let me know about any bugs or other issues that you find. Just email me at <a href="mailto:tomjohnson1492@gmail.com">tomjohnson1492@gmail.com</a>. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues).
{% include links.html %}

4
mydoc/mydoc_supported_features.md → _pages/mydoc/mydoc_supported_features.md
View File

@ -7,7 +7,7 @@ last_updated: "November 30, 2016"
summary: "If you're not sure whether Jekyll and this theme will support your requirements, this list provides a semi-comprehensive overview of available features."
published: true
sidebar: mydoc_sidebar
permalink: /mydoc_supported_features/
permalink: mydoc_supported_features
folder: mydoc
---
@ -50,3 +50,5 @@ Standardized templates | No | You can create pages with any structure you want.
Integration with Swagger | No | You can link to a SwaggerUI output, but there is no built-in integration of SwaggerUI into this documentation theme.
Templates for endpoints | No | Although static site generators work well with API documentation, there aren't any built-in templates specific to endpoints in this theme. You could construct your own, though.
eBook output | No | There isn't an eBook output for the content.
{% include links.html %}

6
mydoc/mydoc_syntax_highlighting.md → _pages/mydoc/mydoc_syntax_highlighting.md
View File

@ -2,10 +2,10 @@
title: Syntax highlighting
tags: [formatting]
keywords: rouge, pygments, prettify, color coding,
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify."
sidebar: mydoc_sidebar
permalink: /mydoc_syntax_highlighting/
permalink: mydoc_syntax_highlighting
folder: mydoc
---
@ -74,3 +74,5 @@ The keywords you must add to specify the highlighting (in the previous example,
* dotnet
* xml
* http
{% include links.html %}

92
mydoc/mydoc_tables.md → _pages/mydoc/mydoc_tables.md
View File

@ -2,11 +2,11 @@
title: Tables
tags: [formatting]
keywords: datatables, tables, grids, markdown, multimarkdown, jquery plugins
last_updated: March 20, 2016
last_updated: July 3, 2016
datatable: true
summary: "You can format tables using either multimarkdown syntax or HTML. You can also use jQuery datatables (a plugin) if you need more robust tables."
sidebar: mydoc_sidebar
permalink: /mydoc_tables/
permalink: mydoc_tables
folder: mydoc
---
@ -29,18 +29,84 @@ $(document).ready(function(){
You can use Multimarkdown syntax for tables. The following shows a sample:
```
Column 1 | Column 2
--------|----------
cell 1a | cell 1b
cell 2a | cell 2b
| Priority apples | Second priority | Third priority |
|-------|--------|---------|
| ambrosia | gala | red delicious |
| pink lady | jazz | macintosh |
| honeycrisp | granny smith | fuji |
```
This renders to the following:
**Result:**
Column 1 | Column 2
--------|----------
cell 1a | cell 1b
cell 2a | cell 2b
| Priority apples | Second priority | Third priority |
|-------|--------|---------|
| ambrosia | gala | red delicious |
| pink lady | jazz | macintosh |
| honeycrisp | granny smith | fuji |
{% include note.html content="You can't use block level tags (paragraphs or lists) inside Markdown tables, so if you need separate paragraphs inside a cell, use `<br/><br/>`." %}
## HTML Tables {#htmltables}
If you need a more sophisticated table syntax, use HTML syntax for the table. Although you're using HTML, you can use Markdown inside the table cells by adding `markdown="1"` as an attribute for the `td` tag, as shown in the following table. You can also control the column widths.
```html
<table>
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<thead>
<tr class="header">
<th align="left">Field</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" markdown="1">First column **fields**</td>
<td align="left" markdown="1">Some descriptive text. This is a markdown link to [Google](http://google.com). Or see [some link][mydoc_tags].</td>
</tr>
<tr>
<td align="left" markdown="1">Second column **fields**</td>
<td align="left" markdown="1">Some more descriptive text. Here we have a Markdown-formatted list:
* first item
* second item
* third item
</td>
</tr>
</tbody>
</table>
```
**Result:**
<table>
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<thead>
<tr class="header">
<th align="left">Field</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" markdown="1">First column **fields**</td>
<td align="left" markdown="1">Some descriptive text. This is a markdown link to [Google](http://google.com). Or see [some link][mydoc_tags].</td>
</tr>
<tr>
<td align="left" markdown="1">Second column **fields**</td>
<td align="left" markdown="1">Some more descriptive text. Here we have a Markdown-formatted list:
* first item
* second item
* third item
</td>
</tr>
</tbody>
</table>
## jQuery datables
@ -162,4 +228,6 @@ Notice a few features:
Read more of the [datatable documentation](https://www.datatables.net/manual/options) to get a sense of the options you can configure. You should probably only use datatables when you have long, massive tables full of information.
{{site.data.alerts.note}} Try to keep the columns to 3 or 4 columns only. If you add 5+ columns, your table may create horizontal scrolling with the theme. Additionally, keep the column heading titles short.{{site.data.alerts.end}}
{% include note.html content=" Try to keep the columns to 3 or 4 columns only. If you add 5+ columns, your table may create horizontal scrolling with the theme. Additionally, keep the column heading titles short." %}
{% include links.html %}

6
mydoc/mydoc_tag_archives_overview.md → _pages/mydoc/mydoc_tag_archives_overview.md
View File

@ -1,11 +1,11 @@
---
title: Tag archives overview
keywords: archives, tagging
last_updated: March 20, 2016
last_updated: July 3, 2016
tags: [navigation]
summary: "This is an overview to the tag archives section. Really the only reason this section is listed explicitly in the TOC here is to demonstrate how to add a third-level to the navigation."
sidebar: mydoc_sidebar
permalink: /mydoc_tag_archives_overview/
permalink: mydoc_tag_archives_overviewß
folder: mydoc
---
@ -14,3 +14,5 @@ folder: mydoc
Tags provide alternate groupings for your content. In the documentation for this theme, there are a number of equally plausible ways I could have grouped the content. The folder names and items I chose for each item could have been grouped in other ways with good reason.
Tags allow you to go beyond the traditional hierarchical classification and provide other groupings. For example, the same item can belong to two different groups. You can also introduce other dimensions not used in your table of contents, such as platform-specific tags or audience-specific tags.
{% include links.html %}

17
mydoc/mydoc_tags.md → _pages/mydoc/mydoc_tags.md
View File

@ -2,35 +2,34 @@
title: Tags
audience: writer, designer
tags: [navigation]
last_updated: March 20, 2016
last_updated: July 3, 2016
keywords: tags, navigation, buttons, links, association
summary: "Tags provide another means of navigation for your content. Unlike the table of contents, tags can show the content in a variety of arrangements and groupings. Implementing tags in this Jekyll theme is somewhat of a manual process."
sidebar: mydoc_sidebar
permalink: /mydoc_tags/
permalink: mydoc_tags
folder: mydoc
---
## Add a tag to a page
You can add tags to pages by adding `tags` in the frontmatter with values inside brackets, like this:
```
---
title: 2.0 Release Notes
permalink: /release_notes_2_0/
permalink: release_notes_2_0/
tags: [formatting, single_sourcing]
---
```
## Tags overview
{{site.data.alerts.note}} With posts, tags have a namespace that you can access with <code>posts.tags.tagname</code>, where <code>tagname</code> is the name of the tag. You can then list all posts in that tag namespace. But pages don't off this same tag namespace, so you could actually use another key instead of <code>tags</code>. Nevertheless, I'm using the same <code>tags</code> approach for posts as with pages.{{site.data.alerts.end}}
{% include note.html content=" With posts, tags have a namespace that you can access with <code>posts.tags.tagname</code>, where <code>tagname</code> is the name of the tag. You can then list all posts in that tag namespace. But pages don't off this same tag namespace, so you could actually use another key instead of <code>tags</code>. Nevertheless, I'm using the same <code>tags</code> approach for posts as with pages." %}
To prevent tags from getting out of control and inconsistent, first make sure the tag appears in the \_data/tags.yml file. If it's not there, the tag you add to a page won't be read. I added this check just to make sure I'm using the same tags consistently and not adding new tags that don't have tag archive pages.
{{site.data.alerts.note}} In contrast to WordPress, with Jekyll to get tags on pages you have to build out the functionality for tags so that clicking a tag name shows you all pages with that tag. Tags in Jekyll are much more manual.{{site.data.alerts.end}}
{% include note.html content="In contrast to WordPress, with Jekyll to get tags on pages you have to build out the functionality for tags so that clicking a tag name shows you all pages with that tag. Tags in Jekyll are much more manual." %}
Additionally, you must create a tag archive page similar to the other pages named tag_{tagname}.html folder. This theme doesn't auto-create tag archive pages.
@ -64,14 +63,14 @@ Tags have a few components.
title: "Collaboration pages"
tagName: collaboration
search: exclude
permalink: /tag_collaboration/
permalink: tag_collaboration/
sidebar: tags_sidebar
---
{% include taglogic.html %}
```
{% endraw %}
{{site.data.alerts.note}}In the \_includes/mydoc folder, there's a taglogic.html file. This file (included in each tag archive file) has common logic for getting the tags and listing out the pages containing the tag in a table with summaries or truncated excerpts. You don't have to do anything with the file &mdash; just leave it there because the tag archive pages reference it.{{site.data.alerts.end}}
{% include note.html content="In the \_includes/mydoc folder, there's a taglogic.html file. This file (included in each tag archive file) has common logic for getting the tags and listing out the pages containing the tag in a table with summaries or truncated excerpts. You don't have to do anything with the file &mdash; just leave it there because the tag archive pages reference it." %}
4. Change the title, tagName, and permalink values to be specific to the tag name you just created.
@ -184,3 +183,5 @@ If you don't want tags to appear at all on your page, remove the tags property f
Since you may have many tags and find it difficult to remember what tags are allowed, I recommend creating a template that prepopulates all your frontmatter with all possible tags. Then just remove the tags that don't apply.
See <a href="{{ "/mydoc_webstorm_text_editor" | prepend: site.baseurl }}">WebStorm Text Editor</a> for tips on creating file templates in WebStorm.
{% include links.html %}

7
mydoc/mydoc_themes.md → _pages/mydoc/mydoc_themes.md
View File

@ -2,14 +2,13 @@
title: Themes
tags: [publishing]
keywords: themes, styles, colors, css
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "You can choose between two different themes (one green, the other blue) for your projects. The theme CSS is stored in the CSS folder and configured in the configuration file for each project."
sidebar: mydoc_sidebar
permalink: /mydoc_themes/
permalink: mydoc_themes
folder: mydoc
---
## Theme options
You can choose a green or blue theme, or you can create your own. In the css folder, there are two theme files: theme-blue.css and theme-green.css. These files have the most common CSS elements extracted in their own CSS file. Just change the hex colors to the ones you want.
@ -23,3 +22,5 @@ In the \_includes/head.html file, specify the theme file you want the output to
The differences between the themes is fairly minimal. The main navigation bar, sidebar, buttons, and heading colors change color. That's about it.
In a more sophisticated theming approach, you could use Sass files to generate rules based on options set in a data file, but I kept things simple here.
{% include links.html %}

6
mydoc/mydoc_troubleshooting.md → _pages/mydoc/mydoc_troubleshooting.md
View File

@ -2,10 +2,10 @@
title: Troubleshooting
tags: [troubleshooting]
keywords: trouble, problems, support, error messages, problems, failure, error, #fail
last_updated: March 20, 2016
last_updated: July 3, 2016
summary: "This page lists common errors and the steps needed to troubleshoot them."
sidebar: mydoc_sidebar
permalink: /mydoc_troubleshooting/
permalink: mydoc_troubleshooting
folder: mydoc
---
@ -73,3 +73,5 @@ If the sidebar levels aren't collapsed, usually your JavaScript is broken somewh
### Search isn't working
If the search isn't working, check the JSON validity in the search.json file in your output folder. Usually something is invalid. Identify the problematic line, fix the file, or put `search: exclude` in the frontmatter of the file to exclude it from search.
{% include links.html %}

2
mydoc/mydoc_webstorm_text_editor.md → _pages/mydoc/mydoc_webstorm_text_editor.md
View File

@ -4,7 +4,7 @@ keywords: webstorm, sublime, markdown, atom, gnome, notepad ++, textpad, bbedit
last_updated: March 20, 2016
summary: "You can use a variety of text editors when working with a Jekyll project. WebStorm from IntelliJ offers a lot of project-specific features, such as find and replace, that make it ideal for working with tech comm projects."
sidebar: mydoc_sidebar
permalink: /mydoc_webstorm_text_editor/
permalink: mydoc_webstorm_text_editor
folder: mydoc
---

142
_pages/mydoc/mydoc_workflow_maps.md Normal file
View File

@ -0,0 +1,142 @@
---
title: Workflow maps
tags: [formatting]
keywords: release notes, announcements, what's new, new features
last_updated: July 3, 2016
summary: "Version 6.0 of the Documentation theme for Jekyll reverts back to relative links so you can view the files offline. Additionally, you can store pages in subdirectories. Templates for alerts and images are available."
sidebar: mydoc_sidebar
permalink: mydoc_workflow_maps
folder: mydoc
---
## Workflow maps overview
You can implement workflow maps at the top of your pages. This is helpful if you're describing a process that involves multiple topics. See the following demos:
* [Simple workflow maps][p2_sample1]
* [Complex workflow maps][p2_sample6]
## Simple workflow maps
1. Create an include at \_includes/custom/usermap.html, where usermap.html contains the workflow and links you want. See the usermap.html as an example. It should look something like this:
```xml
<div id="userMap">
<div class="content"><a href="p2_sample1.html"><div class="box box1">Connect to ADB</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample2.html"><div class="box box2">Download and Build the Starter Kit</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample3.html"><div class="box box3">Take a Tour</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample4.html"><div class="box box4">Load Your Widgets</div></a></div>
<div class="arrow">→</div>
<div class="content"><a href="p2_sample5.html"><div class="box box5">Query for Something</div></a></div>
<div class="clearfix"></div>
</div>
```
You can have only 5 possible workflow squares across. Also, the links must be manually coded HTML like those shown, not automated Markdown links. (This is because the boxes are linked.)
2. Where you want the user maps to appear, add the sidebar properties shown in red below:
<pre>
---
title: Sample 1 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: p2_sample1
folder: product2
<span class="red">simple_map</span>: true
<span class="red">map_name</span>: usermap
<span class="red">box_number</span>: 1
---
</pre>
In the page.html layout, the following code gets activated when `simple_map` equals `true`:
```
{% raw %}{% if page.simple_map == true %}
<script>
$(document).ready ( function(){
$('.box{{page.box_number}}').addClass('active');
});
</script>
{% include custom/{{page.map_name}}.html %}
{% endif %}{% endraw %}
```
The script adds an `active` class to the box number, which automatically makes the active workflow box become highlighted based on the page you're viewing.
The `map_name` gets used as the name of the included file.
## Complex workflow maps
The simpler user workflow allows for 5 workflow steps. If you have a more complex workflow, with multiple possible steps, branching, and more, consider using a complex workflow map. This map uses modals to show a list of instructions and links for each step.
1. Create an include at \_includes/custom/usermapcomplex.html, where usermapcomplex.html contains the workflow and links you want. See the usermapcomplex.html as an example. The code in that file simply implements Bootstrap modals to create the pop-up boxes. Add your custom content inside the modal body:
```
<div class="modal-body">
<p>This is just dummy text ... Your first steps should be to get started. You will need to do the following:</p>
<ul>
<li><a href="p2_sample6.html">Sample 6</a></li>
<li><a href="p2_sample7.html">Sample 7</a></li>
<li><a href="p2_sample8.html">Sample 8</a></li>
</ul>
<p>If you run into any of these setup issues, you must solve them before you can continue on.</p>
</div>
```
The existing usermapcomplex.html file just has 3 workflow square modals. If you need more, duplicate the modal code. In the duplicated code, make sure you make the following values in red unique (but the same within the same modal):
<pre>
<button type="button" class="btn btn-default btn-lg modalButton3" data-toggle="modal" data-target="<span class="red">#myModal3</span>">Publish your app</button>
<!-- Modal -->
<div class="modal fade" id="<span class="red">myModal3</span>" tabindex="-1" role="dialog" aria-labelledby="myModalLabel">
</pre>
2. For each topic where you want the modal to appear, insert the following properties in your frontmatter:
<pre>
---
title: Sample 6 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: p2_sample6
<span class="red">complex_map: true</span>
<span class="red">map_name: usermapcomplex</span>
<span class="red">box_number: 1</span>
toc: false
folder: product2
---
</pre>
When your frontmatter contains `complex_map` equal to `true`, the following code gets activated in the page layout.html file:
```
In the page.html layout, the following code gets activated when `map` equals `true`:
```
{% raw %}{% if page.complex_map == true %}
<script>
$(document).ready ( function(){
$('.modalButton{{page.box_number}}').addClass('active');
});
</script>
{% include custom/{{page.map_name}}.html %}
{% endif %}{% endraw %}
```
```
{% include links.html %}

6
mydoc/mydoc_yaml_tutorial.md → _pages/mydoc/mydoc_yaml_tutorial.md
View File

@ -4,7 +4,7 @@ tags: [formatting]
keywords: search
summary: "YAML is a format that relies on white spacing to separate out the various elements of content. Jekyll lets you use Liquid with YAML as a way to parse through the data. Storing items for your table of contents is one of the most common uses of YAML with Jekyll."
sidebar: mydoc_sidebar
permalink: /mydoc_yaml_tutorial/
permalink: mydoc_yaml_tutorial
folder: mydoc
---
## Overview
@ -27,7 +27,7 @@ YAML itself doesn't do anything on its own &mdash; it's just a way of storing yo
## YAML basics
You can read about YAML from a lot of different sources. Here are some basic characteristics of YAML:
* YAML ("**Y**AML **A**in't **M**arkup **L**anguage") doesn't use markup tags. This means you won't see any kind of angle brackets. It uses white space as a way to form the structure. This makes YAML much more human readable.
* YAML ("YAML Ain't Markup Language") doesn't use markup tags. This means you won't see any kind of angle brackets. It uses white space as a way to form the structure. This makes YAML much more human readable.
* Because YAML does use white space for the structure, YAML is extremely picky about the exactness of spaces. If you have just one extra space somewhere, it can cause the whole file to be invalid.
* For each new level in YAML, you indent two spaces. Each level provides a different access point for the content. You use dot notation to access each new level.
* Because tabs are not universally implemented the same way in editors, a tab might not equate to two spaces. In general, it's best to manually type two spaces to create a new level in YAML.
@ -387,3 +387,5 @@ And here is the result:
## More resources
For more examples and explanations, see this helpful post on tournemille.com: [How to create data-driven navigation in Jekyll](http://www.tournemille.com/blog/How-to-create-data-driven-navigation-in-Jekyll/).
{% include links.html %}

2
news/news.html → _pages/news/news.html
View File

@ -2,7 +2,7 @@
title: News
sidebar: home_sidebar
keywords: news, blog, updates, release notes, announcements
permalink: /news/
permalink: news
toc: false
folder: news
---

2
news/news_archive.html → _pages/news/news_archive.html
View File

@ -2,7 +2,7 @@
title: News
sidebar: tags_sidebar
keywords: news, blog, updates, release notes, announcements
permalink: /news_archive/
permalink: news_archive
toc: false
folder: news
---

2
product1/p1_landing_page.html → _pages/product1/p1_landing_page.html
View File

@ -3,7 +3,7 @@ title: Product 1
keywords: mydoc
sidebar: product1_sidebar
toc: false
permalink: /p1_landing_page/
permalink: p1_landing_page
folder: product1
---
<div class="row">

4
product1/p1_sample1.md → _pages/product1/p1_sample1.md
View File

@ -3,7 +3,7 @@ title: Sample 1 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample1/
permalink: p1_sample1
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

4
product1/p1_sample2.md → _pages/product1/p1_sample2.md
View File

@ -3,7 +3,7 @@ title: Sample 2 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample2/
permalink: p1_sample2
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

4
product1/p1_sample3.md → _pages/product1/p1_sample3.md
View File

@ -3,7 +3,7 @@ title: Sample 3 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample3/
permalink: p1_sample3
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

4
product1/p1_sample4.md → _pages/product1/p1_sample4.md
View File

@ -3,7 +3,7 @@ title: Sample 4 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample4/
permalink: p1_sample4
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

4
product1/p1_sample5.md → _pages/product1/p1_sample5.md
View File

@ -3,7 +3,7 @@ title: Sample 5 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample5/
permalink: p1_sample5
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

4
product1/p1_sample6.md → _pages/product1/p1_sample6.md
View File

@ -3,7 +3,7 @@ title: Sample 6 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample6/
permalink: p1_sample6
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

4
product1/p1_sample7.md → _pages/product1/p1_sample7.md
View File

@ -3,7 +3,7 @@ title: Sample 7 Topic (Product 1)
keywords: sample
summary: "This is just a sample topic..."
sidebar: product1_sidebar
permalink: /p1_sample7/
permalink: p1_sample7
folder: product1
---
@ -21,3 +21,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

2
product2/p2_landing_page.html → _pages/product2/p2_landing_page.html
View File

@ -3,7 +3,7 @@ title: Product 2
keywords: mydoc
sidebar: product2_sidebar
toc: false
permalink: /p2_landing_page/
permalink: p2_landing_page
folder: product2
---
<div class="row">

6
product2/p2_sample1.md → _pages/product2/p2_sample1.md
View File

@ -3,8 +3,8 @@ title: Sample 1 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample1/
map: true
permalink: p2_sample1
simple_map: true
map_name: usermap
box_number: 1
folder: product2
@ -25,3 +25,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample10.md → _pages/product2/p2_sample10.md
View File

@ -3,8 +3,8 @@ title: Sample 10 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample10/
map: true
permalink: p2_sample10
complex_map: true
map_name: usermapcomplex
box_number: 2
toc: false
@ -25,3 +25,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample11.md → _pages/product2/p2_sample11.md
View File

@ -3,8 +3,8 @@ title: Sample 11 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample11/
map: true
permalink: p2_sample11
complex_map: true
map_name: usermapcomplex
box_number: 2
toc: false
@ -25,3 +25,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample12.md → _pages/product2/p2_sample12.md
View File

@ -3,8 +3,8 @@ title: Sample 12 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample12/
map: true
permalink: p2_sample12
complex_map: true
map_name: usermapcomplex
box_number: 3
toc: false
@ -25,3 +25,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample13.md → _pages/product2/p2_sample13.md
View File

@ -3,8 +3,8 @@ title: Sample 13 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample13/
map: true
permalink: p2_sample13
complex_map: true
map_name: usermapcomplex
box_number: 3
toc: false
@ -26,3 +26,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample14.md → _pages/product2/p2_sample14.md
View File

@ -3,8 +3,8 @@ title: Sample 14 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample14/
map: true
permalink: p2_sample14
complex_map: true
map_name: usermapcomplex
box_number: 3
toc: false
@ -26,3 +26,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample2.md → _pages/product2/p2_sample2.md
View File

@ -3,8 +3,8 @@ title: Sample 2 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample2/
map: true
permalink: p2_sample2
simple_map: true
map_name: usermap
box_number: 2
folder: product2
@ -26,3 +26,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

6
product2/p2_sample3.md → _pages/product2/p2_sample3.md
View File

@ -3,8 +3,8 @@ title: Sample 3 Topic
keywords: sample
summary: "This is just a sample topic..."
sidebar: product2_sidebar
permalink: /p2_sample3/
map: true
permalink: p2_sample3
simple_map: true
map_name: usermap
box_number: 3
folder: product2
@ -24,3 +24,5 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
{% include links.html %}

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