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

committing new version of jekyll doc theme -- 5.0, with some refinements to come with the documentation

Browse Source
This commit is contained in:
tomjohnson1492
2016-03-19 00:13:09 -07:00
parent e267cce513
commit 7a869d7cd4
206 changed files with 16935 additions and 37629 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
mydoc/mydoc_title_checker.md
View File

@ -2,11 +2,19 @@
title: Check page title consistency
tags: [navigation]
keywords: "validation, titles, page titles, inconsistency, errors"
last_updated: "November 30, 2015"
last_updated: "November 30, 2016"
summary: "The title checker page helps ensure that the titles in your pages match the titles in your TOC."
sidebar: mydoc_sidebar
permalink: /mydoc_title_checker/
---
To make sure your page titles match the sidebar titles, there's a file called "title-checker.html." After your site builds, view this file in your browser. It will tell if you any of your page titles don't match up with your sidebar titles.
The theme has a file called title-checker.html. This file will iterate through all the pages listed in the sidebar navigation and top navigation, and compare the navigation titles against the page titles based on matching URLs. If there are inconsistencies in the titles, they get noted on the title-checker.html page.
This utility isn't 100% comprehensive, though. If your sidebar has a URL that doesn't match any file name in your project, it won't be able to handle that URL. Therefore, when you do validity checks for the links on your site, click through each item in the sidebar to make sure the page loads.
To run the link checker, just build or serve your project, and go to /title-checker in your browser (such as Chrome). If there are inconsistencies, they will be noted on the page.
Note that in order for the title-checker file to run correctly, it has to detect a match between the URL listed in the sidebar or top navigation with the URL for the page (based on the file name). If you have the wrong URL, it won’t tell you if the page titles match. Therefore you should always click through all the topics in your navigation to make sure the URLs are accurate.
{{site.data.alerts.note}} If your page titles have your product name in parentheses, but your sidebar doesn't have the product name in parentheses, this title-checker tool is going to return a lot of mismatches. This is one limitation of the code right now. {{site.data.alerts.end}}
Note also that you must manually configure your sidebar file in the first line of the code, and then repeat the same chunk of code for each sidebar. Right now the code doesn't automatically iterate over every sidebar file. It's somewhat of a manual configuration process there.