Would you like to add the Marker.io widget to your MkDocs website for easy issue tracking? Let’s walk through the steps below to get you up and running.

How to install the Marker.io widget in MkDocs

Step 1: Create a JavaScript file

Inside your docs folder, create a new subfolder named javascripts.
Inside javascripts, create a new file named marker.js.

Your folder structure should look like:

docs/
  javascripts/
    marker.js

Step 2: Add the Marker.io code

Go to your Marker.io project and copy the JavaScript snippet from Widget > Installation.

Paste the snippet into marker.js. Only copy the code inside the <script> tags, not the tags themselves.

Step 3: Reference the file in your MkDocs config

Open mkdocs.yml and add the file under extra_javascript:

extra_javascript:
  - javascripts/marker.js

Step 4: Rebuild and check your site

Rebuild your site (mkdocs build or mkdocs serve).
Visit your site and confirm the Marker.io widget button appears.

Need Help?

If you have any questions, comments, or corrections, chat with us at the bottom right of our web pages.

MkDocs Integration