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

streamlined my process for managed links a bit by removing some redundancy with the way the urls.txt iterates through each sidebar.

Browse Source
This commit is contained in:
tomjohnson1492
2016-03-30 10:17:01 -07:00
parent e327afb8fe
commit 3b2241c958
7 changed files with 298 additions and 304 deletions
Download Patch File Download Diff File Expand all files Collapse all files

434
_data/urls.yml
View File

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

39
index.md
View File

@ -7,7 +7,7 @@ type: homepage
## Overview ## Overview
These instructions will help you get started quickly with the theme. The other topics in this help provide additional information and detail about working with other aspects of this theme and Jekyll. These brief instructions will help you get started quickly with the theme. The other topics in this help provide additional information and detail about working with other aspects of this theme and Jekyll.
## Build this theme ## Build this theme
@ -67,7 +67,7 @@ The `sidebar: mydoc_sidebar` refers to the \_data/sidebars/mydoc_sidebar.yml fil
If no sidebar assignment is found in the page frontmatter, the default sidebar (specified by the `else` statement) will be shown: `site.data.sidebars.home_sidebar.entries`. If no sidebar assignment is found in the page frontmatter, the default sidebar (specified by the `else` statement) will be shown: `site.data.sidebars.home_sidebar.entries`.
Note that your sidebar can only have 2 levels. Given that each product has its own sidebar, this depth should be sufficient. Deeper nesting goes against usability recommendations. Note that your sidebar can only have 2 levels. Given that each product has its own sidebar, this depth should be sufficient (it's really like 3 levels). Deeper nesting goes against usability recommendations.
For more detail on the sidebar, see {{site.data.urls.mydoc_sidebar_navigation.link}}. For more detail on the sidebar, see {{site.data.urls.mydoc_sidebar_navigation.link}}.
@ -106,9 +106,9 @@ entries:
output: web, pdf output: web, pdf
``` ```
Each folder or subfolder must contain a title and output property. Each folderitem or subfolderitem must contain a title, url, and output property. Each folder or subfolder must contain a title and output property. Each `folderitem` or `subfolderitem` must contain a `title`, `url`, and `output` property.
The two outputs available are web and pdf. (Even if you aren't publishing PDF, you still need to specify `output: web`). The two outputs available are `web` and `pd`f. (Even if you aren't publishing PDF, you still need to specify `output: web`).
The YAML syntax depends on exact spacing, so make sure you follow the pattern shown in the sample sidebars. See my [YAML tutorial](mydoc_yaml_tutorial) for more details about how YAML works. The YAML syntax depends on exact spacing, so make sure you follow the pattern shown in the sample sidebars. See my [YAML tutorial](mydoc_yaml_tutorial) for more details about how YAML works.
@ -198,7 +198,36 @@ See {{site.data.urls.mydoc_posts}} for more information.
## Markdown ## Markdown
This theme uses Kramdown markdown. Kramdown is similar to Github-flavored Markdown, except that when you have text that intercepts list items, the spacing of the intercepting text must align with the spacing of the first character after the space of a numbered list item. See the topics under "Formatting" in the sidebar for more information. This theme uses Kramdown markdown. Kramdown is similar to Github-flavored Markdown, except that when you have text that intercepts list items, the spacing of the intercepting text must align with the spacing of the first character after the space of a numbered list item. Basically, with your list item numbering, use two spaces after the dot in the number, like this:
```
1. First item
2. Second item
3. Third item
```
When you want to insert paragraphs, notes, code snippets, or other matter in between the list items, use four spaces to indent. The four spaces will line up with the first letter of the list item (the **F**irst or **S**econd or **T**hird).
```
1. First item
```
alert("hello");
```
2. Second item
Some pig!
3. Third item
```
See the topics under "Formatting" in the sidebar for more information.
## Managing links
If you want to use a simple system for managing links, see the "Managed Links" section in {{site.data.urls.mydoc_hyperlinks.link}}.
## Other instructions ## Other instructions

45
mydoc/mydoc_hyperlinks.md
View File

@ -47,11 +47,13 @@ In general, avoid broken links and outdated titles in links by doing the followi
* Use a broken link checker on your site output to see if links are broken. * Use a broken link checker on your site output to see if links are broken.
* Generate a PDF, since the PDF tends to highlight broken links more forcefully. * Generate a PDF, since the PDF tends to highlight broken links more forcefully.
## Other methods for managing links ## Managed Links
You can also adopt an indirect-reference systems for managing links. This involves storing the link text in YAML syntax. You can also adopt an indirect-reference systems for managing links. This "managed links" approach involves storing the link text in YAML syntax.
If you want to try this method, look in the root directory. The urls.txt file contains the same code as the table of contents (but without the conditional qualifiers), duplicated for each of the sidebars. The code iterates through every page listed in the table of contents sidebars (as well as the top navigation menus) and creates an output that looks like this for each link: Look at the urls.txt file in the root directory. The urls.txt file contains more or less the same code as the table of contents (but without the conditional qualifiers). A `for` loop runs each of the product sidebars listed in the frontmatter through the url generator.
The code iterates through every page listed in the table of contents sidebars (as well as the top navigation menus) and creates an output that looks like this for each link:
```yaml ```yaml
mydoc_introduction: mydoc_introduction:
@ -60,7 +62,26 @@ mydoc_introduction:
link: "<a href='/mydoc_introduction/'>Introduction</a>" link: "<a href='/mydoc_introduction/'>Introduction</a>"
``` ```
From the site output folder (in \_site), open urls.txt and observe that it is properly populated (blank spaces between entries doesn't matter). Then manually copy the contents from the urls.txt and insert it into the \_data/urls.yml file in your project folder. In the frontmatter for urls.txt, add the name of each of your sidebars, like this:
```yaml
---
layout: none
search: exclude
sidebar:
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
---
```
From the site output folder (in \_site), open urls.txt and observe that it is properly populated (blank spaces between entries doesn't matter). Then manually copy the contents from the urls.txt and insert it into the \_data/urls.yml file in your project folder. Alternatively, run the urls-update.sh file:
```
. urls-update.txt
```
This will move and rename the file through a script.
Because the urls.txt is produced from the table of contents, you ensure that the same titles and URLs used in your table of contents and top navigation will also be used in your inline links. Because the urls.txt is produced from the table of contents, you ensure that the same titles and URLs used in your table of contents and top navigation will also be used in your inline links.
@ -78,7 +99,7 @@ This will insert the following into your topic:
<a href='/mydoc_getting_started/'>Getting started</a> <a href='/mydoc_getting_started/'>Getting started</a>
``` ```
You don't need to worry whether you can use Markdown syntax when inserting a link this way, because the insertion is HTML. You don't need to worry whether you can use Markdown syntax when inserting a link this way, because the code that gets inserted is HTML.
To insert a link in the context of a phrase, you can use this syntax: To insert a link in the context of a phrase, you can use this syntax:
@ -88,7 +109,9 @@ After downloading the theme, you can [get started in building the theme]({{site.
``` ```
{% endraw %} {% endraw %}
This leverages Markdown syntax. If you're in an HTML file or section, use this: Note that `.url` is used instead of `.link`.
If you're in HTML and can't use Markdown, then use the following code:
{% raw %} {% raw %}
```html ```html
@ -96,11 +119,15 @@ This leverages Markdown syntax. If you're in an HTML file or section, use this:
``` ```
{% endraw %} {% endraw %}
Note that the `url` value accesses the URL for the page only, whereas `link` gets the title and url in a link format. The `url` value accesses the URL for the page only, whereas `link` gets the title and url in a link format.
You shouldn't have to copy the contents from the urls.txt file into your YAML data source too often &mdash; only when you're creating new pages. You shouldn't have to transfer the contents from the urls.txt file into your YAML data source too often &mdash; only when you're creating new pages.
I also added a simple script called "run.sh" that performs the urls-update.sh command prior to running Jekyll serve, so you can kill two birds with one stone.
By using this approach, you're less likely to end up with broken links. Note that for the index.html file, which doesn't have a permalink, this file is not included in the urls.txt generation. To link to the homepage, just refer users to the root url of your site.
Overall, by using managed links, you're less likely to end up with broken links.
{{site.data.alerts.tip}} To avoid having to remember this long syntax, use a text macro program like <a href="https://itunes.apple.com/us/app/atext/id488566438?mt=12">aText</a>. {{site.data.alerts.end}} {{site.data.alerts.tip}} To avoid having to remember this long syntax, use a text macro program like <a href="https://itunes.apple.com/us/app/atext/id488566438?mt=12">aText</a>. {{site.data.alerts.end}}

2
mydoc/mydoc_publishing_github_pages.md
View File

@ -43,7 +43,7 @@ Bundler is a package manager for Ruby that will install all dependencies you mig
2. Install Bundler: 2. Install Bundler:
``` ```
brew install bundler gem install bundler
``` ```

6
run.sh Normal file
View File

@ -0,0 +1,6 @@
echo "updating urls.yml"
cd _site;
mv urls.txt ../_data/urls.yml;
cd ../;
echo "serving jekyll"
jekyll serve

2
urls-update.sh Normal file
View File

@ -0,0 +1,2 @@
cd _site
mv urls.txt ../_data/urls.yml

74
urls.txt
View File

@ -1,6 +1,10 @@
--- ---
layout: none layout: none
search: exclude search: exclude
sidebar:
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
--- ---
{% comment %} {% comment %}
@ -13,17 +17,17 @@ search: exclude
{% endcomment %} {% endcomment %}
{% for sidebar in page.sidebar %}
{% for entry in site.data.sidebars.mydoc_sidebar.entries %} {% for entry in site.data.sidebars[sidebar].entries %}
{% for folder in entry.folders %} {% for folder in entry.folders %}
{% for folderitem in folder.folderitems %} {% unless folderitem.type == "frontmatter" or folderitem.external_url %} {% for folderitem in folder.folderitems %} {% unless folderitem.type == "frontmatter" or folderitem.external_url or folderitem.type == "homepage" %}
{{folderitem.url | replace: "/", "" }}: {{folderitem.url | replace: "/", "" }}:
title: "{{folderitem.title }}" title: "{{folderitem.title }}"
url: "{{folderitem.url | prepend: site.baseurl }} '{{folderitem.title}}'" url: "{{folderitem.url | prepend: site.baseurl }} '{{folderitem.title}}'"
link: "<a href='{{folderitem.url | prepend: site.baseurl }}' title='{{folderitem.title}}'>{{folderitem.title}}</a>" link: "<a href='{{folderitem.url | prepend: site.baseurl }}' title='{{folderitem.title}}'>{{folderitem.title}}</a>"
{% endunless %} {% endunless %}
{% for subfolders in folderitem.subfolders %} {% for subfolders in folderitem.subfolders %}
{% for subfolderitem in subfolders.subfolderitems%} {% unless subfolderitem.type == "frontmatter" or subfolderitem.external_url %} {% for subfolderitem in subfolders.subfolderitems%} {% unless subfolderitem.type == "frontmatter" or subfolderitem.external_url or subfolderitem.type == "homepage" %}
{{subfolderitem.url | replace: "/" }}: {{subfolderitem.url | replace: "/" }}:
title: "{{subfolderitem.title}}" title: "{{subfolderitem.title}}"
url: "{{subfolderitem.url| prepend: site.baseurl }} '{{subfolderitem.title}}'" url: "{{subfolderitem.url| prepend: site.baseurl }} '{{subfolderitem.title}}'"
@ -34,73 +38,11 @@ search: exclude
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}
{% comment %}
_ _ _
_ __ _ __ ___ __| |_ _ ___| |_/ |
| '_ \| '__/ _ \ / _` | | | |/ __| __| |
| |_) | | | (_) | (_| | |_| | (__| |_| |
| .__/|_| \___/ \__,_|\__,_|\___|\__|_|
|_|
{% endcomment %}
{% for entry in site.data.sidebars.product1_sidebar.entries %}
{% for folder in entry.folders %}
{% for folderitem in folder.folderitems %} {% unless folderitem.type == "frontmatter" or folderitem.external_url %}
{{folderitem.url | replace: "/", "" }}:
title: "{{folderitem.title }}"
url: "{{folderitem.url | prepend: site.baseurl }} '{{folderitem.title}}'"
link: "<a href='{{folderitem.url | prepend: site.baseurl }}' title='{{folderitem.title}}'>{{folderitem.title}}</a>"
{% endunless %}
{% for subfolders in folderitem.subfolders %}
{% for subfolderitem in subfolders.subfolderitems%} {% unless subfolderitem.type == "frontmatter" or subfolderitem.external_url %}
{{subfolderitem.url | replace: "/" }}:
title: "{{subfolderitem.title}}"
url: "{{subfolderitem.url| prepend: site.baseurl }} '{{subfolderitem.title}}'"
link: "<a href='{{subfolderitem.url | prepend: site.baseurl }}' title='{{subfolderitem.title}}'>{{subfolderitem.title}}</a>"
{% endunless %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %} {% endfor %}
{% comment %}
_ _ ____
_ __ _ __ ___ __| |_ _ ___| |_|___ \
| '_ \| '__/ _ \ / _` | | | |/ __| __| __) |
| |_) | | | (_) | (_| | |_| | (__| |_ / __/
| .__/|_| \___/ \__,_|\__,_|\___|\__|_____|
|_|
{% endcomment %}
{% for entry in site.data.sidebars.product2_sidebar.entries %}
{% for folder in entry.folders %}
{% for folderitem in folder.folderitems %} {% unless folderitem.type == "frontmatter" or folderitem.external_url %}
{{folderitem.url | replace: "/", "" }}:
title: "{{folderitem.title }}"
url: "{{folderitem.url | prepend: site.baseurl }} '{{folderitem.title}}'"
link: "<a href='{{folderitem.url | prepend: site.baseurl }}' title='{{folderitem.title}}'>{{folderitem.title}}</a>"
{% endunless %}
{% for subfolders in folderitem.subfolders %}
{% for subfolderitem in subfolders.subfolderitems%} {% unless subfolderitem.type == "frontmatter" or subfolderitem.external_url %}
{{subfolderitem.url | replace: "/" }}:
title: "{{subfolderitem.title}}"
url: "{{subfolderitem.url| prepend: site.baseurl }} '{{subfolderitem.title}}'"
link: "<a href='{{subfolderitem.url | prepend: site.baseurl }}' title='{{subfolderitem.title}}'>{{subfolderitem.title}}</a>"
{% endunless %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% comment %} {% comment %}
_ _
| |_ ___ _ __ _ __ __ ___ __ | |_ ___ _ __ _ __ __ ___ __