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

content update

Browse Source
This commit is contained in:
Tom Johnson
2015-08-12 09:38:23 -07:00
parent 0655e5323d
commit 655e02f773
5 changed files with 30 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
_includes/custom/doc/doc_homepage.md
View File

@ -2,7 +2,7 @@
## 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.
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
@ -10,15 +10,16 @@ Some of the more prominent features of this theme include the following:
* Bootstrap framework
* Sidebar with page hierarchy
* PDF generation
* PDF generation (with Prince XML utility)
* Notes, tips, and warning information notes
* Tags
* Single sourcing
* 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 featuers, see {{doc_supported_features}}.
For more discussion about the available features, see {{doc_supported_features}}.
## Getting started
@ -26,13 +27,11 @@ 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.
3. {{doc_theme_customization}}
## 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.
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>

4
_includes/custom/doc/links_doc.html
View File

@ -26,8 +26,8 @@
{% 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_theme_customization %}<a href="doc_theme_customization.html">Customizing the theme</a>{% endcapture %}
{% capture doc_theme_customization_i %}<a href="doc_theme_customization.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 %}