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

19
_includes/custom/acme_series.html
View File

@ -1,19 +0,0 @@
<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 | prepend: site.baseurl | append: site.suffix}}">{{p.weight}}. {{p.title}}</a>
</li>
{% endif %}
{% endif %}
{% endfor %}
</ol>
</div>
</div>

30
_includes/custom/conditions.html
View File

@ -1,19 +1,25 @@
{% if site.project == "documentation-theme-jekyll-writer" %}
{% assign audience = "writer" %}
{% assign sidebar = site.data.sidebar.entries %}
{% assign topnav = site.data.topnav.topnav %}
{% assign topnav_dropdowns = site.data.topnav.topnav_dropdowns %}
{% if site.project == "doc" %}
{% assign audience = "writers" %}
{% assign sidebar = site.data.sidebar_doc.entries %}
{% assign topnav = site.data.topnav_doc.topnav %}
{% assign topnav_dropdowns = site.data.topnav_doc.topnav_dropdowns %}
{% assign version = "all" %}
{% assign product = "all" %}
{% assign platform = "all" %}
{% assign platform = "php" %}
{% assign link = "custom/doc/links_doc.html" %}
{% assign projectTags = site.data.tags_doc.allowed-tags %}
{% assign searchGroup = "doc" %}
{% endif %}
{% if site.project == "documentation-theme-jekyll-designer" %}
{% assign audience = "designer" %}
{% assign sidebar = site.data.sidebar.entries %}
{% assign topnav = site.data.topnav.topnav %}
{% assign topnav_dropdowns = site.data.topnav.topnav_dropdowns %}
{% if site.project == "doc" %}
{% assign audience = "designers" %}
{% assign sidebar = site.data.sidebar_doc.entries %}
{% assign topnav = site.data.topnav_doc.topnav %}
{% assign topnav_dropdowns = site.data.topnav_doc.topnav_dropdowns %}
{% assign version = "all" %}
{% assign product = "all" %}
{% assign platform = "all" %}
{% endif %}
{% assign link = "custom/doc/links_doc.html" %}
{% assign projectTags = site.data.tags_doc.allowed-tags %}
{% assign searchGroup = "doc" %}
{% endif %}

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>

33
_includes/custom/homepage.md
View File

@ -1,33 +0,0 @@
{% include linkrefs.html %}
This is a Jekyll theme intended for documentation projects. What makes this theme unique is the approach in using Jekyll for single sourcing, that is, producing multiple outputs from the same theme. For example, you might have 3 different help systems that you're generating from the same Jekyll files. More than anything, this Jekyll theme shows you how to use Jekyll for documentation projects from the perspective of a technical writer.
Note that I'm using this theme for my own technical writing projects, so this is an evolving project.
## Intended audience
Although this theme could be used for any website, I'm assuming that my main audience involves technical writers. Very few technical writers are even aware of Jekyll as a platform, let alone how to use it for tech comm scenarios. The instructions for this theme, therefore, are extensive because they discuss a lot of Jekyll basics as well. I'm not going to assume that you're already familiar with Jekyll, or that you're a UX guru, or that you know how to do backflips in Liquid. I'll try to hold your hand as much as possible.
## Supported features
As far as I can tell, Jekyll supports most of the features a technical writer needs to author and publish content. Most importantly, using Jekyll allows you to take full advantage of a modern web development platform.
As a quick overview, this theme specifically provides the following:
* Bootstrap framework with responsive design
* Integrated search
* Navigation sidebar and top navigation
* Font Awesome
* Options for creating multiple builds for different audiences
See {{supported_features}} for an extensive list.
## Getting started
To get started, see {{getting_started}}. It explains how to create a new project.
## Questions
Feel free to ask me a question if there's something I haven't addressed here.
Tom Johnson <br /><a href="mailto:">tomjohnson1492@gmail.com</a>

60
_includes/custom/links.html
View File

@ -1,60 +0,0 @@
{% comment %}<!-- OVERVIEW -->{% endcomment %}
{% capture name %}<a href="{{"/name" | prepend: site.baseurl}}">Name</a>{% endcapture %}
{% comment %}<!-- OVERVIEW --> {% endcomment %}
{% capture getting_started %}<a href="{{"/getting_started" | prepend: site.baseurl}}">Getting Started</a>{% endcapture %}
{% capture supported_features %}<a href="{{"/supported_features" | prepend: site.baseurl}}">Supported Features</a>{% endcapture %}
{% capture troubleshooting %}<a href="{{"/troubleshooting" | prepend: site.baseurl}}">Troubleshooting</a>{% endcapture %}
{% comment %}<!-- FORMATTING --> {% endcomment %}
{% capture pages %}<a href="{{"/pages" | prepend: site.baseurl}}">Pages</a>{% endcapture %}
{% capture alerts %}<a href="{{"/alerts" | prepend: site.baseurl}}">Alerts</a>{% endcapture %}
{% capture images %}<a href="{{"/images" | prepend: site.baseurl}}">Images</a>{% endcapture %}
{% capture links %}<a href="{{"/links" | prepend: site.baseurl}}">Links</a>{% endcapture %}
{% capture syntax_highlighting %}<a href="{{"/syntax_highlighting" | prepend: site.baseurl}}">Syntax Highlighting</a>{% endcapture %}
{% capture videos %}<a href="{{"/videos" | prepend: site.baseurl}}">Videos</a>{% endcapture %}
{% capture labels %}<a href="{{"/labels" | prepend: site.baseurl}}">Labels</a>{% endcapture %}
{% capture icons %}<a href="{{"/icons" | prepend: site.baseurl}}">Icons</a>{% endcapture %}
{% capture tables %}<a href="{{"/tables" | prepend: site.baseurl}}">Tables</a>{% endcapture %}
{% capture shortcuts_for_jekyll_syntax %}<a href="{{ "/>shortcuts_for_jekyll_syntax" | prepend: site.baseurl }}">Shortcuts for Jekyll Syntax</a> {% endcapture %}
{% comment %}<!-- TAG ARCHIVES --> {% endcomment %}
{% capture tag-overview %}<a href="{{"/tag-overview" | prepend: site.baseurl}}">Overview pages</a>{% endcapture %}
{% capture tag-getting-started %}<a href="{{"/tag-getting-started" | prepend: site.baseurl}}">Getting started pages</a>{% endcapture %}
{% capture tag-single-sourcing %}<a href="{{"/tag-single-sourcing" | prepend: site.baseurl}}">Single-sourcing pages</a>{% endcapture %}
{% capture tag-publishing %}<a href="{{"/tag-publishing" | prepend: site.baseurl}}">Publishing pages</a>{% endcapture %}
{% capture tag-formatting %}<a href="{{"/tag-formatting" | prepend: site.baseurl}}">Formatting pages</a>{% endcapture %}
{% comment %}<!-- SINGLE SOURCING --> {% endcomment %}
{% capture conditional_logic %}<a href="{{"/conditional_logic" | prepend: site.baseurl}}">Conditional logic</a>{% endcapture %}
{% capture content_reuse %}<a href="{{"/content_reuse" | prepend: site.baseurl}}">Content re-use</a>{% endcapture %}
{% capture excluding_files %}<a href="{{"/ excluding_files" | prepend: site.baseurl}}">Excluding files</a>{% endcapture %}
{% comment %}<!-- PUBLISHING --> {% endcomment %}
{% capture build_arguments %}<a href="{{"/build_arguments" | prepend: site.baseurl}}">Build arguments</a>{% endcapture %}
{% capture create_pdf %}<a href="{{"/create_pdf" | prepend: site.baseurl}}">Creating PDFs</a>{% endcapture %}
{% capture help_api %}<a href="{{"/help_api" | prepend: site.baseurl}}">Creating a Help API</a>{% endcapture %}
{% capture configuration_file %}<a href="{{"/configuration_file" | prepend: site.baseurl}}">Creating a Help API</a>{% endcapture %}
{% capture iterm_profiles %}<a href="{{"/iterm_profiles" | prepend: site.baseurl}}">Set Up Profiles in iTerm</a>{% endcapture %}
{% comment %}<!-- NAVIGATION --> {% endcomment %}
{% capture navigation %}<a href="{{"/navigation" | prepend: site.baseurl}}">Creating navigation</a>{% endcapture %}
{% capture tags %}<a href="{{"/tags" | prepend: site.baseurl}}">Creating tags</a>{% endcapture %}
{% comment %} <!-- SPECIAL LAYOUTS --> {% endcomment %}
{% capture special_layouts %}<a href="{{"/special_layouts" | prepend: site.baseurl}}">Special layouts</a>{% endcapture %}
{% capture series %}<a href="{{"/series" | prepend: site.baseurl}}">Series widget</a>{% endcapture %}
{% capture shuffle %}<a href="{{"/shuffle" | prepend: site.baseurl}}">Shuffle layout</a>{% endcapture %}
{% capture scroll %}<a href="{{"/scroll" | prepend: site.baseurl}}">Scroll layout</a>{% endcapture %}
{% capture kb-layout %}<a href="{{"/kb-layout" | prepend: site.baseurl}}">Knowledgebase layout</a>{% endcapture %}
{% capture faq %}<a href="{{"/faq" | prepend: site.baseurl}}">FAQ layout</a>{% endcapture %}

1
_includes/custom/toc_id_note.html
View File

@ -1 +0,0 @@
Make sure you leave the `with_toc_data` option included. This auto-creates an ID for each Markdown-formatted heading, which then gets injected into the mini-TOC. Without this auto-creation of IDs, the mini-TOC won't include the heading. If you ever use HTML formatting for headings, you need to manually add an ID attribute to the heading in order for the heading to appear in the mini-TOC.