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.
Why Marker.io?
With the power of Marker.io, 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 Marker.io 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
docs/
javascripts/
marker.js
Copy the Javascript snippet code from your Marker.io project into the marker.js file
Removing the <script> tags.
Finally, edit the mkdocs.yml file and place the following additional lines:
extra_javascript:
- javascripts/marker.js
A sample mkdocs.yml file:
Now the Marker.io 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.
Check widget visibility settings: Check widget settings like button visibility and privacy settings inside your Marker.io admin.
Still having issues? Contact us anytime in the chat at the bottom right of our website.