Adding a comment system¶
Material for MkDocs is natively integrated with Disqus, a comment system that provides a wide range of features like social integrations, user profiles, as well as spam and moderation tools. Of course, other comment systems can be integrated, too.
Configuration¶
Disqus¶
Source · Default: none
First, ensure you've set site_url
in mkdocs.yml
. Then, to integrate Material for MkDocs with Disqus, create an account and a site giving you a shortname, and add it to mkdocs.yml
:
extra:
disqus: <shortname>
This will insert a comment system on every page, except the index page.
Customization¶
Selective integration¶
Source · Metadata · Difficulty: easy
If the Metadata extension is enabled, you can disable or enable Disqus for specific pages by adding the following to the front matter of a page:
---
disqus: <shortname>
---
# Document title
...
---
disqus: ""
---
# Document title
...
Other comment systems¶
Source · Difficulty: easy
In order to integrate another JavaScript-based comment system provider, you can extend the theme and override the disqus
block:
{% extends "base.html" %}
{% block disqus %}
<!-- Add custom comment system integration here -->
{% endblock %}