OwnShip Guide

Nav Order

By default OwnShip sorts files and folders alphabetically. Drop an _order.txt file into any directory to control the order yourself.

Format

One entry per line. Lines starting with # are comments and are ignored.

# guide nav order
Get
Conf
Cont
Head
Clean
Local
Tip
Upd

Entries are matched against the files in the same directory. Anything not listed falls to the end in alphabetical order.

Add a display name after the filename prefix (separated by a space) to override what appears in the nav for that page. The page's # H1 heading is ignored for nav purposes; the override is used instead.

index    Home
config   Site Settings
about    About Us

This is also how you show the home page (index.md) in the nav — it is hidden by default, but listing it in _order.txt makes it appear at that position with the name you provide.

Matching rules

Case-insensitive. Get, get, and GET all match getting-started.md.

Extension-optional. getting-started and getting-started.md both work.

Prefix matching. You only need enough characters to uniquely identify the file. Get matches getting-started.md; Conf and Cont distinguish configuration.md from content.md.

If a prefix matches more than one file it is treated as a miss — that entry is skipped and those files fall to the end. Make the prefix more specific to resolve it.

Folders need a trailing slash.

intro/
Get
Conf
ref/

Folder entries match directory names; file entries match files. They never cross-match, so a folder named tips and a file named tips.md can coexist without ambiguity — tips/ picks the folder, tips picks the file.

Graceful misses

This means a typo in _order.txt never breaks your nav — it just leaves that item at the end until you fix it.

Scope

Each _order.txt controls only the directory it lives in. Subdirectories use their own _order.txt files.

The nav pane auto-sizes to fit your longest page name, up to a maximum of 300 px. No configuration needed.