Minor modifications (comments + github shield)

README.md

@@ -3,6 +3,7 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 
 [![PyPI](https://img.shields.io/pypi/v/mkdocs-mermaid2-plugin)](https://pypi.org/project/mkdocs-mermaid2-plugin/)
+![Github](https://img.shields.io/github/v/tag/fralau/mkdocs-mermaid2-plugin?label=github%20tag)
 ![Downloads(PyPI)](https://img.shields.io/pypi/dm/mkdocs-mermaid2-plugin)
 
 

mermaid2/plugin.py

@@ -64,7 +64,7 @@ def full_config(self):
     @property
     def mermaid_args(self):
         """
-        The arguments for mermaid.
+        The arguments for mermaid, found in the config file.
         """
         return self._mermaid_args
 
@@ -249,13 +249,13 @@ def on_post_page(self, output_content, config, page, **kwargs):
                 new_tag = BeautifulSoup(self.mermaid_script, 'html.parser')
                 soup.body.append(new_tag)
                 # info(new_tag)
-                # initialization command
+            # insertion of the <script> tag, with the initialization arguments
+            # (self.mermaid_args), as found in the config file.
             new_tag = soup.new_tag("script")
             if self.activate_custom_loader:
                 # if the superfences extension is present, use the specific loader
                 self.mermaid_args['startOnLoad'] = False
                 js_args =  pyjs.dumps(self.mermaid_args) 
-                #new_tag.string = "window.mermaidConfig = {\n    default: %s\n}" % js_args
                 new_tag.string = "window.mermaidConfig = {default: %s}" % js_args
             else:
                 js_args =  pyjs.dumps(self.mermaid_args)