Documentation Sample

Pages

  • Contents
  • Pages
  • HTML Page
  • Markdown Page
  • Templates
  • Example Pages
    • Typography
    • Tables
    • Code Blocks
    • Blockquotes
    • Other Markdown Features
    • More Pages
      • Hosting
      • Code Minifiers
      • Build Times
      • Even More Pages
        • And More
          • Blank Page 1
          • Blank Page 2
          • Blank Page 3
          • Blank Page 4
          • Blank Page 5
          • Blank Page 6
          • Blank Page 7
          • Blank Page 8
          • Blank Page 9
          • Blank Page 10
        • Blank Page 1
        • Blank Page 2
        • Blank Page 3
        • Blank Page 4
        • Blank Page 5
        • Blank Page 6
        • Blank Page 7
        • Blank Page 8
        • Blank Page 9
        • Blank Page 10
      • And More
        • Blank Page 1
        • Blank Page 2
        • Blank Page 3
        • Blank Page 4
        • Blank Page 5
        • Blank Page 6
        • Blank Page 7
        • Blank Page 8
        • Blank Page 9
        • Blank Page 10
  • Page Orders

Page Orders

Author: Jam-Es.com    -    Updated: 2nd June 2020    -    2 minutes to read

You may have noticed the list of pages in the sidenav are in a sensible order. When iterating over all subfolders/pages in the templates, by default folders are displayed first, followed by pages and the order depends on the order they are found by the tool. But if you want to change this order, you need to specify the correct ordering yourself.

How to Order Pages

Ordering pages is done on a 'per folder' basis. Within the Input directory find the folder containing the pages and subfolders you wish to order. Within this folder create a text file called order.config. For example this documentation has the following order.config file directly inside the Input folder:

1 index.html
2 pages.html
3 myhtml.html
4 mymarkdown.md
5 templates.html
6 Example Pages
7 orders.html

You'll notice the file consists of 2 columns separated by a space. The first column asigns an order number to each item (file or subfolder), and the second column specifies the item path (file name or subfolder name). When iterating through the files/folders the tool starts with the smallest order number and finishes with the largest.

You can also override these orders on a 'per page' basis. See the GitHub Wiki for more info.

© Copyright 2020, My Company.