mkdocs-toggle-sidebar-plugin 0.0.9__tar.gz → 0.1.0__tar.gz

{mkdocs_toggle_sidebar_plugin-0.0.9/src/mkdocs_toggle_sidebar_plugin.egg-info → mkdocs_toggle_sidebar_plugin-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-toggle-sidebar-plugin
-Version: 0.0.9
+Version: 0.1.0
 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
@@ -17,7 +17,6 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mkdocs>=1.5.0
 Dynamic: license-file
 
 # mkdocs-toggle-sidebar-plugin
@@ -38,6 +37,10 @@ The settings are stored using the `localStorage` object, so that it will persist
 I wrote it after getting frustrated by the browser's `Find in page` function matching way to many links in the navigation sidebar instead of searching in the actual page's content.
 
 
+## Note on Zensical, MkDocs 1.x, ProperDocs, etc
+
+To make it easy to keep it up to date for all my plugins, I hosted my [intentions of what platforms to support](https://six-two.dev/plugin-support-for-mkdocs-and-forks/) on my website.
+
 ## Usage
 
 ### Setup
@@ -151,6 +154,7 @@ Theme            | Theme version | Plugin version | Status
 ---              | ---           | ---            | ---
 mkdocs-ansible   | 25.6.0        | 0.0.6          | works
 mkdocs-material  | 9.6.14        | 0.0.4+         | works
+mkdocs-materialx | 10.1.5        | 0.1.0          | works        
 mkdocs (default) | 1.6.1         | 0.0.4+         | works
 readthedocs      | 1.6.1         | 0.0.4+         | works
 
@@ -187,6 +191,11 @@ docker run --rm -it -v "$PWD:/share" -w "/share" -p 8000:8000 --entrypoint=bash
 
 ## Notable changes
 
+### Version 0.1.0
+
+- Added autodetection for [MaterialX](https://github.com/jaywhj/mkdocs-materialx) theme.
+- Removed dependency declaration of `mkdocs`
+
 ### Version 0.0.9
 
 - Added `button_toggle_both_tooltip`, `button_toggle_nav_tooltip`, `button_toggle_toc_tooltip` and `button_toggle_icon` options for customizing the toggle button (see #12)

{mkdocs_toggle_sidebar_plugin-0.0.9 → mkdocs_toggle_sidebar_plugin-0.1.0}/README.md

@@ -16,6 +16,10 @@ The settings are stored using the `localStorage` object, so that it will persist
 I wrote it after getting frustrated by the browser's `Find in page` function matching way to many links in the navigation sidebar instead of searching in the actual page's content.
 
 
+## Note on Zensical, MkDocs 1.x, ProperDocs, etc
+
+To make it easy to keep it up to date for all my plugins, I hosted my [intentions of what platforms to support](https://six-two.dev/plugin-support-for-mkdocs-and-forks/) on my website.
+
 ## Usage
 
 ### Setup
@@ -129,6 +133,7 @@ Theme            | Theme version | Plugin version | Status
 ---              | ---           | ---            | ---
 mkdocs-ansible   | 25.6.0        | 0.0.6          | works
 mkdocs-material  | 9.6.14        | 0.0.4+         | works
+mkdocs-materialx | 10.1.5        | 0.1.0          | works        
 mkdocs (default) | 1.6.1         | 0.0.4+         | works
 readthedocs      | 1.6.1         | 0.0.4+         | works
 
@@ -165,6 +170,11 @@ docker run --rm -it -v "$PWD:/share" -w "/share" -p 8000:8000 --entrypoint=bash
 
 ## Notable changes
 
+### Version 0.1.0
+
+- Added autodetection for [MaterialX](https://github.com/jaywhj/mkdocs-materialx) theme.
+- Removed dependency declaration of `mkdocs`
+
 ### Version 0.0.9
 
 - Added `button_toggle_both_tooltip`, `button_toggle_nav_tooltip`, `button_toggle_toc_tooltip` and `button_toggle_icon` options for customizing the toggle button (see #12)

{mkdocs_toggle_sidebar_plugin-0.0.9 → mkdocs_toggle_sidebar_plugin-0.1.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = mkdocs-toggle-sidebar-plugin
-version = 0.0.9
+version = 0.1.0
 author = six-two
 author_email = pip@six-two.dev
 description = Add keybindings to toggle the navigation and table of contents sidebars
@@ -25,8 +25,6 @@ package_dir =
 packages = find:
 python_requires = >=3.9
 scripts = 
-install_requires = 
-	mkdocs>=1.5.0
 
 [options.entry_points]
 mkdocs.plugins = 

{mkdocs_toggle_sidebar_plugin-0.0.9 → mkdocs_toggle_sidebar_plugin-0.1.0}/src/mkdocs_toggle_sidebar_plugin/__init__.py

@@ -3,11 +3,16 @@ import os
 import urllib.parse
 import xml.etree.ElementTree as ET
 # pip dependency
-from mkdocs.plugins import BasePlugin, get_plugin_logger
-from mkdocs.config.defaults import MkDocsConfig
-from mkdocs.config.base import Config
-from mkdocs.config.config_options import Type
-from mkdocs.exceptions import PluginError
+try:
+    from mkdocs.plugins import BasePlugin, get_plugin_logger
+    from mkdocs.config.defaults import MkDocsConfig
+    from mkdocs.config.base import Config
+    from mkdocs.config.config_options import Type
+    from mkdocs.exceptions import PluginError
+except ImportError as ex:
+    print("[-] Error importing 'mkdocs'. Please install 'properdocs' (recommended) or 'mkdocs<=1.6.1' (deprecated) with pip")
+    exit(1)
+
 
 LOGGER = get_plugin_logger(__name__)
 SCRIPT_DIR = os.path.dirname(__file__)
@@ -15,6 +20,7 @@ ALLOWED_TOGGLE_BUTTON_VALUES = ["none", "navigation", "toc", "all"]
 # This is a map of compatible themes. For example 'ansible' inherits from 'material', so the material javascript will work for the ansible theme too
 THEME_COMPATIBILITY = {
     "ansible": "material",
+    "materialx": "material",
 }
 # May not always be accurate, this is just for a more helpful error message
 KNOWN_THEME_NAMES = ["material", "mkdocs", "readthedocs"] + list(THEME_COMPATIBILITY.keys())

{mkdocs_toggle_sidebar_plugin-0.0.9 → mkdocs_toggle_sidebar_plugin-0.1.0/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.9
+Version: 0.1.0
 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
@@ -17,7 +17,6 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mkdocs>=1.5.0
 Dynamic: license-file
 
 # mkdocs-toggle-sidebar-plugin
@@ -38,6 +37,10 @@ The settings are stored using the `localStorage` object, so that it will persist
 I wrote it after getting frustrated by the browser's `Find in page` function matching way to many links in the navigation sidebar instead of searching in the actual page's content.
 
 
+## Note on Zensical, MkDocs 1.x, ProperDocs, etc
+
+To make it easy to keep it up to date for all my plugins, I hosted my [intentions of what platforms to support](https://six-two.dev/plugin-support-for-mkdocs-and-forks/) on my website.
+
 ## Usage
 
 ### Setup
@@ -151,6 +154,7 @@ Theme            | Theme version | Plugin version | Status
 ---              | ---           | ---            | ---
 mkdocs-ansible   | 25.6.0        | 0.0.6          | works
 mkdocs-material  | 9.6.14        | 0.0.4+         | works
+mkdocs-materialx | 10.1.5        | 0.1.0          | works        
 mkdocs (default) | 1.6.1         | 0.0.4+         | works
 readthedocs      | 1.6.1         | 0.0.4+         | works
 
@@ -187,6 +191,11 @@ docker run --rm -it -v "$PWD:/share" -w "/share" -p 8000:8000 --entrypoint=bash
 
 ## Notable changes
 
+### Version 0.1.0
+
+- Added autodetection for [MaterialX](https://github.com/jaywhj/mkdocs-materialx) theme.
+- Removed dependency declaration of `mkdocs`
+
 ### Version 0.0.9
 
 - Added `button_toggle_both_tooltip`, `button_toggle_nav_tooltip`, `button_toggle_toc_tooltip` and `button_toggle_icon` options for customizing the toggle button (see #12)

{mkdocs_toggle_sidebar_plugin-0.0.9 → mkdocs_toggle_sidebar_plugin-0.1.0}/src/mkdocs_toggle_sidebar_plugin.egg-info/SOURCES.txt

@@ -12,5 +12,4 @@ src/mkdocs_toggle_sidebar_plugin.egg-info/PKG-INFO
 src/mkdocs_toggle_sidebar_plugin.egg-info/SOURCES.txt
 src/mkdocs_toggle_sidebar_plugin.egg-info/dependency_links.txt
 src/mkdocs_toggle_sidebar_plugin.egg-info/entry_points.txt
-src/mkdocs_toggle_sidebar_plugin.egg-info/requires.txt
 src/mkdocs_toggle_sidebar_plugin.egg-info/top_level.txt

mkdocs_toggle_sidebar_plugin-0.0.9/src/mkdocs_toggle_sidebar_plugin.egg-info/requires.txt

@@ -1 +0,0 @@
-mkdocs>=1.5.0