update comments for use of pathconverter

flybywiresim · Mar 22, 2023 · a27535a · a27535a
1 parent b630cee
commit a27535a
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -150,8 +150,8 @@ markdown_extensions:
   pymdownx.emoji: # Allows emoji style inline embeds for icons
     emoji_index: !!python/name:materialx.emoji.twemoji
     emoji_generator: !!python/name:materialx.emoji.to_svg
-  pymdownx.pathconverter:
-    base_path: 'docs' # default: ''
+  pymdownx.pathconverter: # Allows for absolute linking of images and other assets
+    base_path: 'docs' # repository root
     relative_path: '' # default ''
     absolute: true # default: false
     tags: 'a script img link object embed'