generateMkdocsIndex

emlib.doctools.generateMkdocsIndex(projectName, shortDescription, author='<author name>', email='<author email>', url='<Project URL>', longDescription='<Long Description>', quickStart='<Quick Start>', includeWelcome=True, fmt='markdown')[source]

Generate the template for an index file suitable for mkdocs

Parameters:

  • projectName (str) – the name of the project

  • shortDescription (str) – a short description (a line)

  • author (str) – the author of the project

  • email (str) – author’s email

  • url (str) – url of the project (github, etc)

  • longDescription (str) – long description of the project (a paragraph)

  • quickStart (str) – an introduction to the project (multiple paragraphs)

Return type:

str

Returns:

a string which could be saved to an index.md file