documenting site.title parameters

This commit is contained in:
Tom Johnson
2015-05-18 09:55:58 -07:00
parent d94672fe62
commit 7399c0400a
5 changed files with 13 additions and 2 deletions

View File

@ -3,7 +3,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
<meta name="keywords" content="{{page.tags}}{% if page.tags %}, {% endif %} {{page.keywords}}">
<title>{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}</title>
<title>{% if page.homepage == true %} {{site.homepage_title}} {% elsif page.title %}{{ page.title }}{% endif %} | {{ site.site_title }}</title>
<link rel="stylesheet" href="{{ "/css/syntax.css" | prepend:site.baseurl }}" type='text/css'>
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

View File

@ -17,3 +17,7 @@ tagline: Guide for designers
baseurl: "/documentation-theme-jekyll/designer"
port: 4006
homepage_title: Doc theme for Jekyll -- designer version
site_title: Documentation theme for Jekyll -- designer version

View File

@ -20,3 +20,7 @@ baseurl: "/documentation-theme-jekyll/writer"
port: 4008
destination: ../documentation-theme-jekyll-builds/writer
homepage_title: Doc theme for Jekyll -- writer version
site_title: Documentation theme for Jekyll -- designer version

View File

@ -2,6 +2,7 @@
title: Documentation Theme for Jekyll
permalink: "/"
tags: overview
homepage: true
---
{% include linkrefs.html %}

View File

@ -53,6 +53,8 @@ Later configuration files will override settings in earlier configuration files.
| **tagline** | Optional | Appears above the sidebar. Usually you put some tag related to the site specific build, such as the audience.|
| **topnav_title** | Required | Appears next to the home button in the top nav bar.|
| **topnav_version** | Optional | Appears next to the title (which is next to the home button) in the top nav bar.|
| **homepage_title**| Required | If you're using includes to pull in the homepage content, then you set the title for your homepage via the configuration file. This is because multiple files are being displayed on the index.md page depending on the project. The page layout will use the homepage_title instead of the one on the include.|
| **site_title**| |
| **baseurl** | Optional | The folder where the help will appear when published. If you're publishing one version of your doc into a root directory, this isn't needed. However, most likely you will publish each output into its own folder, so add a value for the baseurl. Note that your site *must* be published in this baseurl in order to display correctly. This is because the links in the published site build are not all relative in the same way. However, you can publish the same output onto different domains (as long as you keep the same baseurl folder on those different domains).
| **url** | Optional. | Recommended to not include this, since it allows you to easily push help from one domain to another (such as from a test environment to a production environment. As long as the baseurl's folder remains the same, the help will display well. I think the only use for the url is for the RSS feed. |
| **baseurl** | Optional | The baseurl is everything that comes after the domain (acme.com). If you publish at acme.com/folder/version/role, then the baseurl is folder/version/role. Jekyll is hard-coded to only display properly when placed inside this baseurl folder. |