Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.65 KB

folder.md

File metadata and controls

54 lines (37 loc) · 1.65 KB
Raw
label icon tags
Folder config
file-directory
config

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 a pages, although properties such as description and layout would not be applicable in the context of a folder configuration and will be ignored. !!!

Samples

Set a custom icon for the folder.

icon: gear

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

expanded: true

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

order: 1000

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

order: -1000

Change the folder label used for the navigation node label.

label: Custom label

Hide a folder by setting the visibility configuration.

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.