Merge pull request #14 from neatc0der/feature/simplify-configuration

simplify configuration effort

Author: neatc0der

README.md

@@ -24,8 +24,6 @@ pip install mkdocs-markmap
 Add this to `mkdocs.yml`:
 
 ```yaml
-markdown_extensions:
-  - markmap
 plugins:
   - markmap
 ```
@@ -36,12 +34,11 @@ There are more options available for `mkdocs.yml` (shown values are defaults):
 
 ```yaml
 markdown_extensions:
+plugins:
   - markmap:
       base_path: docs
       encoding: utf-8
       file_extension: .mm.md
-plugins:
-  - markmap:
       d3_version: 6.3.1
       lib_version: 0.11.1
       view_version: 0.2.1
@@ -62,40 +59,6 @@ extra_javascript:
 * `markmap-lib`
 * `markmap-view`
 
-## Wait, what?! Do I need an extension or a plugin? :unamused:
-
-_Q: What does the plugin do?_
-
-A: It supports code blocks of markdown as follows:
-
-````markdown
-```markmap
-# Root
-
-## Branch 1
-
-* Branchlet 1a
-* Branchlet 1b
-
-## Branch 2
-
-* Branchlet 2a
-* Branchlet 2b
-```
-````
-
-_Q: What does the extension do?_
-
-A: Well, having such a support is nice, but huge mindmap blocks might be annoying within your tidy markdown files. That is why the extension provides an addition to the markdown syntax. It includes files whereever you need them to be:
-
-```markdown
-Look at this beautiful mindmap:
-
-{!mindmap.mm.md!}
-```
-
-But you _do_ need the plugin for that. Thus, don't forget to follow the quickstart example above.
-
 ## Credits :clap:
 
 Some of the development approaches are based on implementations provided by the following projects:

mkdocs_markmap/extension.py

@@ -72,12 +72,14 @@ def run(self, lines: List[str]) -> List[str]:
 
 
 class MarkmapExtension(Extension):
+    config_defaults: Dict[str, str] = {
+        'base_path': ['docs', 'Default location from which to evaluate relative paths for the include statement.'],
+        'encoding': ['utf-8', 'Encoding of the files used by the include statement.'],
+        'file_extension': ['.mm.md', 'File extension of mindmap files'],
+    }
+
     def __init__(self, **configs: Dict[str, str]):
-        self.config: Dict[str, str] = {
-            'base_path': ['docs', 'Default location from which to evaluate relative paths for the include statement.'],
-            'encoding': ['utf-8', 'Encoding of the files used by the include statement.'],
-            'file_extension': ['.mm.md', 'File extension of mindmap files'],
-        }
+        self.config: Dict[str, str] = self.config_defaults
         for key, value in configs.items():
             self.setConfig(key, value)
 

mkdocs_markmap/plugin.py

@@ -1,4 +1,5 @@
 import logging
+from mkdocs_markmap.extension import MarkmapExtension
 import re
 from pathlib import Path
 from typing import Dict, Tuple
@@ -8,7 +9,6 @@
 from mkdocs.structure.pages import Page
 from mkdocs.config.base import Config
 from mkdocs.config.config_options import Type as PluginType
-from mkdocs.utils import copy_file
 
 from .defaults import MARKMAP
 from .utils import download
@@ -30,6 +30,9 @@ class MarkmapPlugin(BasePlugin):
             (f'{name}_version', PluginType(str, default=module.version))
             for name, module in MARKMAP.items()
         ),
+        ('base_path', PluginType(str, default='docs')),
+        ('encoding', PluginType(str, default='utf-8')),
+        ('file_extension', PluginType(str, default='.mm.md')),
     )
 
     def __init__(self):
@@ -78,6 +81,16 @@ def _add_statics(soup: BeautifulSoup):
                 tag.string = fp.read()
             getattr(soup, attribute).append(tag)    
 
+    def on_config(self, config: Config) -> Config:
+        config['markdown_extensions'].append('markmap')
+        config['mdx_configs']['markmap'] = {
+            key: value
+            for key, value in config['plugins'].get('markmap').config.items()
+            if key in MarkmapExtension.config_defaults
+        }
+
+        return config
+
     def on_post_page(self, output_content: str, config: Config, **kwargs) -> str:
         soup: BeautifulSoup = BeautifulSoup(output_content, 'html.parser')
         page: Page = kwargs.get('page')