MkDocs Integration

Add the Pulse script to your MkDocs site using a custom template override.

Step 1: Create a custom template override

To include the data-domain attribute, create a template override file.

{% extends "base.html" %}

{% block extrahead %}
<script
  defer
  data-domain="your-site.com"
  src="https://pulse.ciphera.net/script.js"
></script>
{% endblock %}

Step 2: Configure mkdocs.yml

Set the custom_dir to your overrides folder in your MkDocs configuration.

theme:
  name: material
  custom_dir: overrides

For more details, see the MkDocs customization docs.

Related Integrations: Docusaurus, VitePress, Django