Variable getMkDocsYmlConst

Type Declaration

• • (
        inputDir: string,
        options?: { mkdocsConfigFileName?: string; name?: string },
    ): Promise<{ configIsTemporary: boolean; content: string; path: string }>

  • Finds and loads the contents of an mkdocs.yml, mkdocs.yaml file, a file with a specified name or an ad-hoc created file with minimal config.

    Parameters

    • inputDir: string

      base dir to be searched for either an mkdocs.yml or mkdocs.yaml file.

    • Optionaloptions: { mkdocsConfigFileName?: string; name?: string }

      name: default mkdocs site_name to be used with a ad hoc file default value is "Documentation Site" mkdocsConfigFileName (optional): a non-default file name to be used as the config

    Returns Promise<{ configIsTemporary: boolean; content: string; path: string }>