markdownHeader

emlib.doctools.markdownHeader(text, headernum, inline=True)[source]

Create a markdown header

Parameters:

  • text (str) – The text of the header

  • headernum (int) – the header number (int >= 1)

  • inline (bool) – if inline, the header is of the form “# header”, otherwise the header is applied as underline

Return type:

str

Returns:

the markdown text, either one line if inline, or two lines otherwise