MkDocs Integration

Website feedback on MkDocs in a few quick steps

Joe Scanlon avatar
Written by Joe Scanlon
Updated over a week ago

Why MkDocs?

MkDocs is a fast, simple static site generator that builds project documentation. Documentation source files are written in Markdown and configured with a single YAML configuration file. Start by reading the introductory tutorial and User Guide for more information.


With the power of, collecting website feedback on MkDocsis a breeze, saving hours of developer time. Collect your feedback directly into your favorite PM tools and issue trackers.

How to add to MkDocs

To add additional JavaScript to MkDocs, create a subfolder inside the docs folder let's call this javascripts and within that folder, create your JavaScript file, let's call this marker.js


Copy the Javascript snippet code from your project into the marker.js file

Removing the <script> tags.

Finally, edit the mkdocs.yml file and place the following additional lines:

- javascripts/marker.js

A sample mkdocs.yml file:

Now the feedback widget will appear on your MkDocs website. Happy reporting!

Widget not displaying on your MkDocs website?

If your widget is not displaying, try the following:

  • Ensure your website[s] is listed under website domains. Navigate to your project settings > Settings > General > Website domains. Check that the correct website domain(s) is listed here.

Still having issues? Contact us anytime in the chat at the bottom right of our website.

Did this answer your question?