mkdocs-toggle-sidebar-plugin 0.0.6__tar.gz → 0.0.8__tar.gz

{mkdocs_toggle_sidebar_plugin-0.0.6/src/mkdocs_toggle_sidebar_plugin.egg-info → mkdocs_toggle_sidebar_plugin-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-toggle-sidebar-plugin
-Version: 0.0.6
+Version: 0.0.8
 Summary: Add keybindings to toggle the navigation and table of contents sidebars
 Home-page: https://github.com/six-two/mkdocs-toggle-sidebar-plugin
 Author: six-two
@@ -93,7 +93,7 @@ Option | Type | Default value | Description
 async | `bool` | `False` | Asynchronously load the JavaScript file created by the plugin
 debug | `bool` | `False` | Show some debug messages during mkdocs build (for example related to theme detection)
 enabled | `bool` | `True` | Can be used to disable the plugin. Usually used in combination with environment variables like `enabled: !ENV [TOGGLE_SIDEBAR, false]` as described in [mkdocs's docs](https://www.mkdocs.org/user-guide/configuration/#enabled-option)
-inline | `bool` | `True` | Instead of storing the javascript code in the file specified by `javascript`, it is directly copied into each page. Slightly increases page size, but can improve load times a little bit and reduce flickering on page (re-)load
+inline | `bool` | `False` | Instead of storing the javascript code in the file specified by `javascript`, it is directly copied into each page. Slightly increases page size, but can improve load times a little bit and reduce flickering on page (re-)load
 javascript | `str` | `"assets/javascripts/toggle-sidebar.js"` | The path where to store the output file
 show_navigation_by_default | `bool` | `True` | Whether to show the navigation by default
 show_toc_by_default | `bool` | `True` | Whether to show the table of contents by default
@@ -169,6 +169,14 @@ docker run --rm -it -v "$PWD:/share" -w "/share" -p 8000:8000 --entrypoint=bash
 
 ## Notable changes
 
+### Version 0.0.8
+
+- Fixed toggle button not shown in certain window dimensions in Material theme (see #11)
+
+### Version 0.0.7
+
+- Fixed sidebar not hidden in material's blog mode (see #9). Thank you @ZnPdCo for finding and fixing the issue.
+
 ### Version 0.0.6
 
 - Fixed toggle button appearing delayed on slow loading pages (see #6)

{mkdocs_toggle_sidebar_plugin-0.0.6 → mkdocs_toggle_sidebar_plugin-0.0.8}/README.md

@@ -71,7 +71,7 @@ Option | Type | Default value | Description
 async | `bool` | `False` | Asynchronously load the JavaScript file created by the plugin
 debug | `bool` | `False` | Show some debug messages during mkdocs build (for example related to theme detection)
 enabled | `bool` | `True` | Can be used to disable the plugin. Usually used in combination with environment variables like `enabled: !ENV [TOGGLE_SIDEBAR, false]` as described in [mkdocs's docs](https://www.mkdocs.org/user-guide/configuration/#enabled-option)
-inline | `bool` | `True` | Instead of storing the javascript code in the file specified by `javascript`, it is directly copied into each page. Slightly increases page size, but can improve load times a little bit and reduce flickering on page (re-)load
+inline | `bool` | `False` | Instead of storing the javascript code in the file specified by `javascript`, it is directly copied into each page. Slightly increases page size, but can improve load times a little bit and reduce flickering on page (re-)load
 javascript | `str` | `"assets/javascripts/toggle-sidebar.js"` | The path where to store the output file
 show_navigation_by_default | `bool` | `True` | Whether to show the navigation by default
 show_toc_by_default | `bool` | `True` | Whether to show the table of contents by default
@@ -147,6 +147,14 @@ docker run --rm -it -v "$PWD:/share" -w "/share" -p 8000:8000 --entrypoint=bash
 
 ## Notable changes
 
+### Version 0.0.8
+
+- Fixed toggle button not shown in certain window dimensions in Material theme (see #11)
+
+### Version 0.0.7
+
+- Fixed sidebar not hidden in material's blog mode (see #9). Thank you @ZnPdCo for finding and fixing the issue.
+
 ### Version 0.0.6
 
 - Fixed toggle button appearing delayed on slow loading pages (see #6)

{mkdocs_toggle_sidebar_plugin-0.0.6 → mkdocs_toggle_sidebar_plugin-0.0.8}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = mkdocs-toggle-sidebar-plugin
-version = 0.0.6
+version = 0.0.8
 author = six-two
 author_email = pip@six-two.dev
 description = Add keybindings to toggle the navigation and table of contents sidebars

{mkdocs_toggle_sidebar_plugin-0.0.6 → mkdocs_toggle_sidebar_plugin-0.0.8}/src/mkdocs_toggle_sidebar_plugin/__init__.py

@@ -1,4 +1,5 @@
 import os
+import urllib.parse
 # pip dependency
 from mkdocs.plugins import BasePlugin, get_plugin_logger
 from mkdocs.config.defaults import MkDocsConfig
@@ -25,7 +26,7 @@ class PluginConfig(Config):
     async_ = Type(bool, default=False)
     javascript = Type(str, default="assets/javascripts/toggle-sidebar.js")
     debug = Type(bool, default=False)
-    inline = Type(bool, default=True)
+    inline = Type(bool, default=False)
 
 
 def is_known_theme(theme_name: str) -> bool:
@@ -43,6 +44,10 @@ def get_unknown_theme_message(theme_name: str, auto_detect_enabled: bool) -> str
         basic_help = "You are overwriting the theme in this plugin's configuration in your mkdocs.yml. Make sure you spelled the theme's name correctly."
     return f"Theme '{theme_name}' is not (yet) supported. The currently supported themes are: {', '.join(KNOWN_THEME_NAMES)}.\nRecommended steps:\n1. {basic_help}\n2. Try updating this plugin to the latest version: pip install -U mkdocs-toggle-sidebar-plugin\n3. Check if an issue for this theme exists: https://github.com/six-two/mkdocs-toggle-sidebar-plugin/issues\n4. If no issue exists feel free to open one. Please put the theme name and path where to download it in the issue"
     
+def get_base_url_by_url(url: str):
+    if url == '':
+        return './'
+    return url.count('/') * '../'
 
 class Plugin(BasePlugin[PluginConfig]):
     def on_config(self, config: MkDocsConfig, **kwargs) -> MkDocsConfig:
@@ -70,7 +75,7 @@ class Plugin(BasePlugin[PluginConfig]):
             else:
                 if not is_known_theme(theme_name):
                     LOGGER.warning(get_unknown_theme_message(theme_name, False))
-
+            
             # If the theme is known to be based on another theme, then we resolve it to the base theme
             resolved_theme_name = THEME_COMPATIBILITY.get(theme_name, theme_name)
 
@@ -80,17 +85,9 @@ class Plugin(BasePlugin[PluginConfig]):
                 with open(theme_path) as f:
                     self.theme_function_definitions = f.read()
 
-        if self.theme_function_definitions:
-            if self.config.inline:
+            if self.theme_function_definitions and self.config.inline:
                 # We cache it for performance reasons
-                self.inline_javascript = f"<script>{self.get_toggle_sidebar_javascript()}</script>"
-            else:
-                # Add a custom script reference
-                custom_script = ExtraScriptValue(self.config.javascript)
-                if self.config.async_:
-                    custom_script.async_ = True
-                
-                config.extra_javascript.append(custom_script)
+                self.inline_javascript = f"<script>{self.get_toggle_sidebar_javascript(config)}</script>"
         
         if self.config.toggle_button not in ALLOWED_TOGGLE_BUTTON_VALUES:
             raise PluginError(f"Unexpected value for 'toggle_button': '{self.config.toggle_button}'. Allowed values are {', '.join(ALLOWED_TOGGLE_BUTTON_VALUES)}")
@@ -103,29 +100,40 @@ class Plugin(BasePlugin[PluginConfig]):
             LOGGER.debug(message)
 
     def on_post_page(self, html, /, *, page, config):
-        if self.inline_javascript:
-            html = html.replace("</head>", self.inline_javascript + "</head>")
+        if self.config.enabled and self.theme_function_definitions:
+            if self.inline_javascript:
+                html = html.replace("</head>", self.inline_javascript + "</head>")
+            else:
+                base_url = get_base_url_by_url(page.url)
+                script_src = urllib.parse.quote(base_url + self.config.javascript.lstrip("./"))
+                if self.config.async_:
+                    script = f'<script src="{script_src}" async></script>'
+                else:
+                    script = f'<script src="{script_src}"></script>'
+                html = html.replace("</head>", script + "</head>")
+        
         return html
 
     def on_post_build(self, config: MkDocsConfig) -> None:
         if self.theme_function_definitions and not self.config.inline:
             target_path = os.path.join(config.site_dir, self.config.javascript)
-            if os.path.exists(target_path):
-                # The file exists. This probably means, that the user wanted to override the default file
-                # So we just do nothing
-                pass
-            else:
-                # Make sure that the folder exists
-                parent_dir = os.path.dirname(target_path)
-                os.makedirs(parent_dir, exist_ok=True)
-                
-                # Copy the file, while also editing it on the fly
-                javascript = self.get_toggle_sidebar_javascript()
-                with open(target_path, "w") as f:
-                    f.write(javascript)
+            # To properly replace placeholders, we need to replace the JS file, even if it already exists
+            # Make sure that the folder exists
+            parent_dir = os.path.dirname(target_path)
+            os.makedirs(parent_dir, exist_ok=True)
+            
+            # Copy the file, while also editing it on the fly
+            javascript = self.get_toggle_sidebar_javascript(config)
+            with open(target_path, "w") as f:
+                f.write(javascript)
+
+    def get_toggle_sidebar_javascript(self, config: MkDocsConfig):
+        # Default to the output path of the JavaScript file, so that users can modify the JavaScript (even in inline mode)
+        asset_path = os.path.join(config.docs_dir, self.config.javascript)
+        if not os.path.exists(asset_path):
+            asset_path = os.path.join(SCRIPT_DIR, "toggle-sidebar.js")
+        self.debug(f"[*] Loading JavaScript template from {asset_path}")
 
-    def get_toggle_sidebar_javascript(self):
-        asset_path = os.path.join(SCRIPT_DIR, "toggle-sidebar.js")
         with open(asset_path) as f:
             data = f.read()
         data = data.replace("THEME_DEPENDENT_FUNCTION_DEFINITION_PLACEHOLDER", self.theme_function_definitions)

{mkdocs_toggle_sidebar_plugin-0.0.6 → mkdocs_toggle_sidebar_plugin-0.0.8}/src/mkdocs_toggle_sidebar_plugin/material.js

@@ -1,7 +1,7 @@
 const setCombinedVisibility = (showNavigation, showTOC) => {
     // Hide the button when on mobile (and menu us shown as hamburger menu anyways).
-    // The exact max-width is taken from the styling of the 'body > header > nav > a' element
-    
+    // Uses the 60em threshold that is used for hiding the TOC, search bar, repo info (name + stars), etc
+
     let style = `
 .mkdocs-toggle-sidebar-button {
     cursor: pointer;
@@ -9,7 +9,7 @@ const setCombinedVisibility = (showNavigation, showTOC) => {
     margin-left: 1rem;
 }
 
-@media screen and (max-width: 76.1875em) {
+@media screen and (max-width: 60em) {
     .mkdocs-toggle-sidebar-button {
         display: none;
     }
@@ -29,10 +29,12 @@ if (!showTOC) {
         }
         
     // We always have to show the navigation in mobile view, otherwise the hamburger menu is broken
+    // In material for mkdocs's blog mode, navigation's class is '.md-sidebar--post', see #9
+    // The exact width (76.1875em) is taken from the styling of the 'body > header > nav > a' element, I think
     if (!showNavigation) {
         style += `
 @media screen and (min-width: 76.1875em) {
-    div.md-sidebar.md-sidebar--primary {
+    div.md-sidebar.md-sidebar--primary, div.md-sidebar.md-sidebar--post {
         display: none;
     }
 }

{mkdocs_toggle_sidebar_plugin-0.0.6 → mkdocs_toggle_sidebar_plugin-0.0.8/src/mkdocs_toggle_sidebar_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-toggle-sidebar-plugin
-Version: 0.0.6
+Version: 0.0.8
 Summary: Add keybindings to toggle the navigation and table of contents sidebars
 Home-page: https://github.com/six-two/mkdocs-toggle-sidebar-plugin
 Author: six-two
@@ -93,7 +93,7 @@ Option | Type | Default value | Description
 async | `bool` | `False` | Asynchronously load the JavaScript file created by the plugin
 debug | `bool` | `False` | Show some debug messages during mkdocs build (for example related to theme detection)
 enabled | `bool` | `True` | Can be used to disable the plugin. Usually used in combination with environment variables like `enabled: !ENV [TOGGLE_SIDEBAR, false]` as described in [mkdocs's docs](https://www.mkdocs.org/user-guide/configuration/#enabled-option)
-inline | `bool` | `True` | Instead of storing the javascript code in the file specified by `javascript`, it is directly copied into each page. Slightly increases page size, but can improve load times a little bit and reduce flickering on page (re-)load
+inline | `bool` | `False` | Instead of storing the javascript code in the file specified by `javascript`, it is directly copied into each page. Slightly increases page size, but can improve load times a little bit and reduce flickering on page (re-)load
 javascript | `str` | `"assets/javascripts/toggle-sidebar.js"` | The path where to store the output file
 show_navigation_by_default | `bool` | `True` | Whether to show the navigation by default
 show_toc_by_default | `bool` | `True` | Whether to show the table of contents by default
@@ -169,6 +169,14 @@ docker run --rm -it -v "$PWD:/share" -w "/share" -p 8000:8000 --entrypoint=bash
 
 ## Notable changes
 
+### Version 0.0.8
+
+- Fixed toggle button not shown in certain window dimensions in Material theme (see #11)
+
+### Version 0.0.7
+
+- Fixed sidebar not hidden in material's blog mode (see #9). Thank you @ZnPdCo for finding and fixing the issue.
+
 ### Version 0.0.6
 
 - Fixed toggle button appearing delayed on slow loading pages (see #6)