Mkdocs

.qd.out.mkdocs.write

Organizes Markdown files generated by the .qd.doc function in a directory structure that can be consumed by mkdocs to build a static HTML site. Copy the files output by this function to an mkdocs dev environment and execute mkdocs serve or mkdocs build to build a static HTML site.

Mkdocs is not required to run this function since it doesn't actually build the site.

Parameters:

Name	Type	Description
settings	.qd.out.mkdocs.settings	Optional. Pass generic null to use defaults
output	.qd.output	Output from the .qd.doc function A dictionary of path to the output directory (MD files), markdown content in each file and the table of errors

Returns:

Name	Type	Description
<returns>	dict	Filenames of all the md files written to the disk
<returns>.out	symbol
<returns>.md	table
<returns>.md.file	symbol

See Also: .qd.doc

Example: Setup with default settings

 .qd.out.mkdocs.write[::] .qd.doc[::] `.foo.q

Example: Setup with user defined config, index and assets

 .qd.out.mkdocs.write[`config`index`assets!`:/path/to/mkdocs.yml`:/path/to/index.md`:/path/to/assets] .qd.doc[::] `.foo.q

Example: Group the items by subcategory

 .qd.out.mkdocs.write[``group!``subcategory] .qd.doc[``group!``subcategory] `.foo.q