The Main File

Functions

createVuepressSidebar(options) → Promise

Create the sidebar

parseDirectoryFile(file, argv) → Promise

Parse file

createReadmeFile(argv, deletedPaths) → void

Create the readme file. First page when entering the documentation.

parseArguments(argv) → object

Parse all CLI arguments

generate(argv)

Default command that generate md files

watchFiles(argv)

Watch files in source folder

createVuepressSidebar(options) → Promise

Create the sidebar

Kind: global function

Param	Type
options	object

parseDirectoryFile(file, argv) → Promise

Parse file

Kind: global function

Param	Type
file	DirectoryFile
argv	CLIArguments

createReadmeFile(argv, deletedPaths) → void

Create the readme file. First page when entering the documentation.

Kind: global function

Param	Type
argv	CLIArguments
deletedPaths	string

parseArguments(argv) → object

Parse all CLI arguments

Kind: global function
Returns: object - all arguments

Param	Type
argv	CLIArguments

generate(argv)

Default command that generate md files

Kind: global function

Param	Type	Description
argv	object	passed arguments

watchFiles(argv)

Watch files in source folder

Kind: global function

Param	Type
argv	CLIArguments