Storyteller supports the idea of a hierarchical navigation structure that is inferred from the structure of the files in the
The navigation tree structure is derived using these rules:
The root folder and each child folder (
/contentis treated specially) is treated like a node within the tree with the
splash.htmfile considered to be the root of that node
Other topic files named with the pattern
[key].mdare additional topics that are nested directly underneath the
index.mdtopic in that folder.
If there is a child folder, the
/[key]/index.mdtopic node is nested directly underneath the parent folder's root.
Child topics in a topic node directory are ordered by the title of the child topics unless there is an
order.txtfile as described below
Explicit Topic Ordering with "Order.txt"
To override the default ordering of topics, create a file named
order.txt in that directory and simply list the file names without the .md extension of the topics in that directory in the order in which you wish the navigation to flow. Any files that are not part of the
order.txt file are simply put at the end by sorting on their title.
As an example, consider the topic you're reading right now. This file is called "navigation.md" and is in Storyteller's GitHub repository here with all its sibling files. To create the navigation order in what we hope is a logical narrative, we used an order.txt file to configure the ordering like so:
getting_started authoring navigation outlines samples theme running export
Child folders can be part of the ordering by just using the child folder name as the key in
order.txt. See this file ordering the Storyteller documentation that orders the documentation topics at http://storyteller.github.io/documentation.