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

version 3.0 of the theme -- complete overhaul

Browse Source
This commit is contained in:
Tom Johnson
2015-08-11 16:48:17 -07:00
parent 95fa839f0c
commit 6cab011d1b
181 changed files with 4747 additions and 10289 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
_includes/custom/doc/customMenu.html Normal file
View File

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

39
_includes/custom/doc/doc_homepage.md Normal file
View File

@ -0,0 +1,39 @@
{% 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. Out of the box, Jekyll's theme is pretty basic.
## Survey of features
Some of the more prominent features of this theme include the following:
* Bootstrap framework
* Sidebar with page hierarchy
* PDF generation
* Notes, tips, and warning information notes
* Tags
* Single sourcing
* Emphasis on pages, not posts
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 featuers, see {{doc_supported_features}}.
## Getting started
To get started, see these three topics:
1. {{doc_getting_started}}
2. {{doc_configuration_settings}}
3. {{doc_customize_the_theme}}
After that, the topics aren't in any particular order.
## PDF Download
If you would like to download this help file as a PDF, you can do so here. The PDF is comprehensive of all the content in the online help.
<a target="_blank" class="noCrossRef" href="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).

120
_includes/custom/doc/links_doc.html Normal file
View File

@ -0,0 +1,120 @@
{% comment %} leave this end_i capture here, since many 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">Configuration settings</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_customize_the_theme %}<a href="doc_customize_the_theme.html">Customizing the theme</a>{% endcapture %}
{% capture doc_customize_the_theme_i %}<a href="doc_customize_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</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_links %}<a href="doc_links.html">Links</a>{% endcapture %}
{% capture doc_links_i %}<a href="doc_links.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 %}

19
_includes/custom/doc/series_acme.html Normal file
View File

@ -0,0 +1,19 @@
<div class="seriesContext">
<div class="btn-group">
<button type="button" data-toggle="dropdown" class="btn btn-primary dropdown-toggle">Series Demo <span class="caret"></span></button>
<ol class="dropdown-menu">
{% assign pages = site.pages | sort:"weight" %}
{% for p in pages %}
{% if p.series == "ACME series" %}
{% if p.url == page.url %}
<li class="active"> → {{p.weight}}. {{p.title}}</li>
{% else %}
<li>
<a href="{{p.url}}">{{p.weight}}. {{p.title}}</a>
</li>
{% endif %}
{% endif %}
{% endfor %}
</ol>
</div>
</div>

10
_includes/custom/doc/series_acme_next.html Normal file
View File

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