Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 1.33 KB

metadata.md

File metadata and controls

34 lines (29 loc) · 1.33 KB
cloud solution-title solution-hub-url getting-started-title getting-started-url tutorials-title tutorials-url mini-toc-levels git-repo index type
Document Cloud
Document Cloud
Getting Started
Tutorials
2
true
Tutorial

Metadata for internal use

The metadata.md file includes repo-level metadata that passes through to user guide TOC.md files in the repo. If you want to change metadata.md content for any user guide, do so in any TOC.md file.

metadata what it does
solution-title Used in article header as link
solution-hub-url Opens helpx hub page
solution-icon Displays solution icon next to solution title. Not yet implemented
getting-started-url Link to helpx getting started page
tutorials-url Link to video tutorials--either helpx tutorials or KT tutorials
mini-toc-levels Determines the number of heading levels that appear in right rail. default is 2
git-repo Specifies the location of the master repo for internal use

In TOC.md file

metadata what it does
user-guide-title Used in article header as link
user-guide-url Opens helpx hub page