fsMode()

function fsMode(
   path, 
   rootPath, 
   config): SidebarItem | undefined;

Defined in: modes/fs.ts:23

Filesystem mode

Parameters

Parameter	Type	Description
path	string	Path to start reading the filesystem from
rootPath	string	Root path for relative links
config	Config	Configuration to use

Returns

SidebarItem | undefined

A generated SidebarItem or, if nothing could be resolved, undefined

Since

1.0.0

Author

Simon Kovtyk