Skip to content

Comments ¤

Adds a Comments Section, using utteranc.es

The comments are hosted by github issues and fetched via a central bot at utteranc.es.

Important

  • Based on a central bot
  • Works for public repos hosted on github exclusively.

Features¤

  • Supports mkdocs materials' navigation.instant, i.e. comments sections are (re-)loaded on nav clicks.
  • Supports hiding the comments within collapsed details sections

Syntax¤

`lp:python show=comments`

Parameters¤

'theme': 'github-dark',  # "github-light" "github-dark" "preferred-color-scheme" "github-dark-orange" "icy-dark" "dark-blue" "photon-dark" "boxy-light"
'issue_term': 'pathname',  # url, title, og:title (specific issue number and title not supported)

Example¤

Code:

 ??? "Questions and Comments?"
     `lp:python show=comments eval=always`

Renders:

Questions and Comments?

Back to top