manualMode()

function manualMode(
   path, 
   rootPath, 
   config): ManualModeReturn | undefined;

Defined in: modes/manual.ts:76

Manual 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

ManualModeReturn | undefined

ManualModeReturn, that contains a SidebarItem or, if nothing could be resolved, undefined

Since

1.1.0

Author

Simon Kovtyk