#Folder configuration

Using the same .yml technique and options as Page configuration, a folder can be configured using a separate index.yml file placed inside the folder.

Folders support the same properties as pages, although a few properties that are not applicable in the context of a folder configuration would be ignored, such as description.

#icon

Set a custom icon for the folder.

index.yml


icon: gear

#expanded

Expand the folder node in the tree navigation with the expanded config.

index.yml
expanded: true

#label

Change the folder label used for the left navigation tree node label.

index.yml


label: Custom label

#order

Move a folder up to the top of the navigation by setting the order. The higher the number, the higher in the stack the folder will be placed.

index.yml
order: 1000

Move a folder to the bottom of the navigation. The lower the number, the lower in the stack it will be placed.

index.yml
order: -1000

#nextprev

This config is Retype PRO only.

The nextprev configuration controls the display of "Next" and "Previous" navigation buttons at the bottom of each page and whether a page is included in the navigation sequence.

#mode

mode : string

Controls how the Next/Previous navigation buttons are displayed and whether the page is included in the navigation sequence.

Option	Description
`show`	Show Next and Previous buttons and include page in sequence (Default)
`hide`	Hide buttons but keep page in sequential order
`exclude`	Hide buttons and exclude page from sequential order

The default value is show.

nextprev:
  mode: hide # Pro key required

See also Project and Page configuration of nextprev.mode.

#permalink

Configures a new permanent base path for all pages within this directory.

See Page permalink for full details.

index.yml


permalink: /tutorials

#visibility

Hide a folder by setting the visibility configuration.

index.yml


visibility: hidden

Another option to completely ignore a folder or a file would be to prefix the folder name or file name with an underscore _. For instance, naming a folder _guides would instruct Retype to ignore the folder.

Password protect an entire folder by setting the visibility to either protected or private.

index.yml


visibility: protected

config