Skip to main content

on_post_build

Writes the collected search records to a JSON file in the site directory after the build process is complete.

def on_post_build(
config: Config
) - > None

Writes the collected search index records to a JSON file in the site directory after the build process completes.

Parameters

NameTypeDescription
configConfigThe MkDocs configuration object containing the site directory path where the search records will be stored

Returns

TypeDescription
NoneNothing is returned; the function performs a file system write operation.