I changed the way I create links to use references to a data YML file instead of relying on the capture tag and including reference to the file with the captions. Using the capture tag was highly susceptible to broken links and way too manual. See the Links topic for more detail about the new method.

This commit is contained in:
Tom Johnson
2015-09-13 16:33:16 -07:00
parent a24859dc66
commit 445b1d1f44
59 changed files with 14296 additions and 14054 deletions

View File

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

View File

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

View File

@ -1,38 +0,0 @@
{% include linkrefs.html %}
## Overview
This site provides documentation, training, and other notes for the Jekyll Documentation theme. There's a lot of information about how to do a variety of things here, and it's not all unique to this theme. But by and large, understanding how to do things in Jekyll depends on how your theme is coded.
## Survey of features
Some of the more prominent features of this theme include the following:
* Bootstrap framework
* Sidebar with page hierarchy and advanced toc
* PDF generation (with Prince XML utility)
* Notes, tips, and warning information notes
* Tags
* Single sourced outputs
* Emphasis on pages, not posts
* Relative (rather than absolute) link structure
I'm using this theme for my documentation projects, building about 15 different outputs for various products, versions, languages, and audiences from the same set of files. This single sourcing requirement has influenced how I constructed this theme.
For more discussion about the available features, see {{doc_supported_features}}.
## Getting started
To get started, see these three topics:
1. {{doc_getting_started}}
2. {{doc_configuration_settings}}
3. {{doc_customizing_the_theme}}
## PDF Download
If you would like to download this help file as a PDF, you can do so here. The PDF most of the same content as the online help, except that some elements (such as video or special layouts) don't translate the the print medium, so they're excluded.
<a target="_blank" class="noCrossRef" href="doc_{{site.audience}}_pdf.pdf"><button type="button" class="btn btn-default" aria-label="Left Align"><span class="glyphicon glyphicon-download-alt" aria-hidden="true"></span> PDF Download</button></a>
The PDF contains a timestamp in the header indicating when it was last generated. If you download a PDF, keep in mind that it may go out of date quickly. Always compare your PDF timestamp against the online help timestamp (which you can find in the footer).

View File

@ -1,129 +0,0 @@
{% comment %} leave this end_i capture here, since all links with _i rely on it. {% endcomment %}
{% capture end_i %}</a>{% endcapture %}
{% capture doc_about %}<a href="about.html">About this theme</a>{% endcapture %}
{% capture doc_about_i %}<a href="about.html">{% endcapture %}
{% capture doc_adding_tooltips %}<a href="doc_adding_tooltips.html">Tooltips</a>{% endcapture %}
{% capture doc_adding_tooltips_i %}<a href="doc_adding_tooltips.html">{% endcapture %}
{% capture doc_alerts %}<a href="doc_alerts.html">Alerts</a>{% endcapture %}
{% capture doc_alerts_i %}<a href="doc_alerts.html">{% endcapture %}
{% capture doc_build_arguments %}<a href="doc_build_arguments.html">Build arguments</a>{% endcapture %}
{% capture doc_build_arguments_i %}<a href="doc_build_arguments.html">{% endcapture %}
{% capture doc_collections %}<a href="doc_collections.html">Collections</a>{% endcapture %}
{% capture doc_collections_i %}<a href="doc_collections.html">{% endcapture %}
{% capture doc_conditional_logic %}<a href="doc_conditional_logic.html">Conditional logic</a>{% endcapture %}
{% capture doc_conditional_logic_i %}<a href="doc_conditional_logic.html">{% endcapture %}
{% capture doc_configuration_settings %}<a href="doc_configuration_settings.html">Setting configuration options</a>{% endcapture %}
{% capture doc_configuration_settings_i %}<a href="doc_configuration_settings.html">{% endcapture %}
{% capture doc_content_reuse %}<a href="doc_content_reuse.html">Content reuse</a>{% endcapture %}
{% capture doc_content_reuse_i %}<a href="doc_content_reuse.html">{% endcapture %}
{% capture doc_customizing_the_theme %}<a href="doc_customizing_the_theme.html">Customizing the theme</a>{% endcapture %}
{% capture doc_customizing_the_theme_i %}<a href="doc_customizing_the_theme.html">{% endcapture %}
{% capture doc_excluding_files %}<a href="doc_excluding_files.html">Excluding files</a>{% endcapture %}
{% capture doc_excluding_files_i %}<a href="doc_excluding_files.html">{% endcapture %}
{% capture doc_faq %}<a href="doc_faq.html">FAQ layout</a>{% endcapture %}
{% capture doc_faq_i %}<a href="doc_faq.html">{% endcapture %}
{% capture doc_generating_pdfs %}<a href="doc_generating_pdfs.html">Generating PDFs</a>{% endcapture %}
{% capture doc_generating_pdfs_i %}<a href="doc_generating_pdfs.html">{% endcapture %}
{% capture doc_getting_started %}<a href="doc_getting_started.html">Getting started with this theme</a>{% endcapture %}
{% capture doc_getting_started_i %}<a href="doc_getting_started.html">{% endcapture %}
{% capture doc_glossary %}<a href="doc_glossary.html">Glossary layout</a>{% endcapture %}
{% capture doc_glossary_i %}<a href="doc_glossary.html">{% endcapture %}
{% capture doc_help_api %}<a href="doc_help_api.html">Help API and UI tooltips</a>{% endcapture %}
{% capture doc_help_api_i %}<a href="doc_help_api.html">{% endcapture %}
{% capture doc_icons %}<a href="doc_icons.html">Icons</a>{% endcapture %}
{% capture doc_icons_i %}<a href="doc_icons.html">{% endcapture %}
{% capture doc_images %}<a href="doc_images.html">Images</a>{% endcapture %}
{% capture doc_images_i %}<a href="doc_images.html">{% endcapture %}
{% capture doc_kb_layout %}<a href="doc_kb_layout.html">Knowledge-base layout</a>{% endcapture %}
{% capture doc_kb_layout_i %}<a href="doc_kb_layout.html">{% endcapture %}
{% capture doc_labels %}<a href="doc_labels.html">Labels</a>{% endcapture %}
{% capture doc_labels_i %}<a href="doc_labels.html">{% endcapture %}
{% capture doc_hyperlinks %}<a href="doc_hyperlinks.html">Links</a>{% endcapture %}
{% capture doc_hyperlinks_i %}<a href="doc_hyperlinks.html">{% endcapture %}
{% capture doc_navtabs %}<a href="doc_navtabs.html">Navtabs</a>{% endcapture %}
{% capture doc_navtabs_i %}<a href="doc_navtabs.html">{% endcapture %}
{% capture doc_pages %}<a href="doc_pages.html">Pages</a>{% endcapture %}
{% capture doc_pages_i %}<a href="doc_pages.html">{% endcapture %}
{% capture doc_push_build_to_server %}<a href="doc_push_build_to_server.html">Pushing builds to the server</a>{% endcapture %}
{% capture doc_push_build_to_server_i %}<a href="doc_push_build_to_server.html">{% endcapture %}
{% capture doc_search_configuration %}<a href="doc_search_configuration.html">Search configuration</a>{% endcapture %}
{% capture doc_search_configuration_i %}<a href="doc_search_configuration.html">{% endcapture %}
{% capture doc_series %}<a href="doc_series.html">Series pages</a>{% endcapture %}
{% capture doc_series_i %}<a href="doc_series.html">{% endcapture %}
{% capture doc_shuffle %}<a href="doc_shuffle.html">Shuffle layout</a>{% endcapture %}
{% capture doc_shuffle_i %}<a href="doc_shuffle.html">{% endcapture %}
{% capture doc_sidebar_navigation %}<a href="doc_sidebar_navigation.html">Sidebar navigation</a>{% endcapture %}
{% capture doc_sidebar_navigation_i %}<a href="doc_sidebar_navigation.html">{% endcapture %}
{% capture doc_special_layouts %}<a href="doc_special_layouts.html">Special layouts</a>{% endcapture %}
{% capture doc_special_layouts_i %}<a href="doc_special_layouts.html">{% endcapture %}
{% capture doc_support %}<a href="doc_support.html">Support</a>{% endcapture %}
{% capture doc_support_i %}<a href="doc_support.html">{% endcapture %}
{% capture doc_supported_features %}<a href="doc_supported_features.html">Supported features</a>{% endcapture %}
{% capture doc_supported_features_i %}<a href="doc_supported_features.html">{% endcapture %}
{% capture doc_syntax_highlighting %}<a href="doc_syntax_highlighting.html">Syntax highlighting</a>{% endcapture %}
{% capture doc_syntax_highlighting_i %}<a href="doc_syntax_highlighting.html">{% endcapture %}
{% capture doc_tables %}<a href="doc_tables.html">Tables</a>{% endcapture %}
{% capture doc_tables_i %}<a href="doc_tables.html">{% endcapture %}
{% capture doc_tags %}<a href="doc_tags.html">Tags</a>{% endcapture %}
{% capture doc_tags_i %}<a href="doc_tags.html">{% endcapture %}
{% capture doc_themes %}<a href="doc_themes.html">Themes</a>{% endcapture %}
{% capture doc_themes_i %}<a href="doc_themes.html">{% endcapture %}
{% capture doc_top_navigation %}<a href="doc_top_navigation.html">Top navigation</a>{% endcapture %}
{% capture doc_top_navigation_i %}<a href="doc_top_navigation.html">{% endcapture %}
{% capture doc_troubleshooting %}<a href="doc_troubleshooting.html">Troubleshooting</a>{% endcapture %}
{% capture doc_troubleshooting_i %}<a href="doc_troubleshooting.html">{% endcapture %}
{% capture doc_video_embeds %}<a href="doc_video_embeds.html">Video embeds</a>{% endcapture %}
{% capture doc_video_embeds_i %}<a href="doc_video_embeds.html">{% endcapture %}
{% capture doc_iterm_profiles %}<a href="doc_iterm_profiles.html">iTerm profiles</a>{% endcapture %}
{% capture doc_iterm_profiles_i %}<a href="doc_iterm_profiles.html">{% endcapture %}
{% capture doc_webstorm_text_editor %}<a href="doc_webstorm_text_editor.html">WebStorm Text Editor</a>{% endcapture %}
{% capture doc_webstorm_text_editor_i %}<a href="doc_webstorm_text_editor.html">{% endcapture %}
{% capture doc_seriesdemo1_1 %}<a href="doc_seriesdemo1_1.html">Series demo</a>{% endcapture %}
{% capture doc_seriesdemo1_1_i %}<a href="doc_seriesdemo1_1.html">{% endcapture %}

View File

@ -9,11 +9,8 @@
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/modern-business.css">
<link rel="stylesheet" type="text/css" href="css/lavish-bootstrap.css">
<link rel="canonical" href="{{ page.url | replace:'index.html',''}}">
<link rel="stylesheet" type="text/css" href="css/customstyles.css">
<link rel="stylesheet" type="text/css" href="css/{{site.theme_file}}">
<link rel="canonical" href="{{ page.url | replace:'index.html','' }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="feed.xml" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="js/jquery.navgoco.min.js"></script>

View File

@ -1,4 +0,0 @@
{% include custom/conditions.html %}
{% include {{link}} %}
{% include alerts.html %}
{% include callouts.html %}