mkdocs-toggle-sidebar-plugin 0.0.4__tar.gz → 0.0.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {mkdocs_toggle_sidebar_plugin-0.0.4/src/mkdocs_toggle_sidebar_plugin.egg-info → mkdocs_toggle_sidebar_plugin-0.0.5}/PKG-INFO +7 -3
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/README.md +5 -1
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/setup.cfg +2 -2
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin/material.js +20 -14
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5/src/mkdocs_toggle_sidebar_plugin.egg-info}/PKG-INFO +7 -3
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/LICENSE +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/MANIFEST.in +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/pyproject.toml +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin/__init__.py +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin/mkdocs.js +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin/readthedocs.js +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin/toggle-sidebar.js +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin.egg-info/SOURCES.txt +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin.egg-info/dependency_links.txt +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin.egg-info/entry_points.txt +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin.egg-info/requires.txt +0 -0
- {mkdocs_toggle_sidebar_plugin-0.0.4 → mkdocs_toggle_sidebar_plugin-0.0.5}/src/mkdocs_toggle_sidebar_plugin.egg-info/top_level.txt +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mkdocs-toggle-sidebar-plugin
|
|
3
|
-
Version: 0.0.
|
|
4
|
-
Summary: Add keybindings to toggle the table of contents
|
|
3
|
+
Version: 0.0.5
|
|
4
|
+
Summary: Add keybindings to toggle the navigation and table of contents sidebars
|
|
5
5
|
Home-page: https://github.com/six-two/mkdocs-toggle-sidebar-plugin
|
|
6
6
|
Author: six-two
|
|
7
7
|
Author-email: pip@six-two.dev
|
|
@@ -114,11 +114,15 @@ Test mkdocs theme:
|
|
|
114
114
|
|
|
115
115
|
## Notable changes
|
|
116
116
|
|
|
117
|
+
### Version 0.0.5
|
|
118
|
+
|
|
119
|
+
- Bug fix: On small screens with the material theme the navigation would be hidden, even when the hamburger menu was opened.
|
|
120
|
+
|
|
117
121
|
### Version 0.0.4
|
|
118
122
|
|
|
119
123
|
- Export API via `MkdocsToggleSidebarPlugin` object.
|
|
120
124
|
This lets you create custom buttons or key bindings to hide, show or toggle the side bars.
|
|
121
|
-
- Added `toggle_button` option and implemented it for Material theme
|
|
125
|
+
- Added `toggle_button` option and implemented it for Material theme.
|
|
122
126
|
|
|
123
127
|
### Version 0.0.3
|
|
124
128
|
|
|
@@ -95,11 +95,15 @@ Test mkdocs theme:
|
|
|
95
95
|
|
|
96
96
|
## Notable changes
|
|
97
97
|
|
|
98
|
+
### Version 0.0.5
|
|
99
|
+
|
|
100
|
+
- Bug fix: On small screens with the material theme the navigation would be hidden, even when the hamburger menu was opened.
|
|
101
|
+
|
|
98
102
|
### Version 0.0.4
|
|
99
103
|
|
|
100
104
|
- Export API via `MkdocsToggleSidebarPlugin` object.
|
|
101
105
|
This lets you create custom buttons or key bindings to hide, show or toggle the side bars.
|
|
102
|
-
- Added `toggle_button` option and implemented it for Material theme
|
|
106
|
+
- Added `toggle_button` option and implemented it for Material theme.
|
|
103
107
|
|
|
104
108
|
### Version 0.0.3
|
|
105
109
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
[metadata]
|
|
2
2
|
name = mkdocs-toggle-sidebar-plugin
|
|
3
|
-
version = 0.0.
|
|
3
|
+
version = 0.0.5
|
|
4
4
|
author = six-two
|
|
5
5
|
author_email = pip@six-two.dev
|
|
6
|
-
description = Add keybindings to toggle the table of contents
|
|
6
|
+
description = Add keybindings to toggle the navigation and table of contents sidebars
|
|
7
7
|
long_description = file: README.md
|
|
8
8
|
long_description_content_type = text/markdown
|
|
9
9
|
url = https://github.com/six-two/mkdocs-toggle-sidebar-plugin
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
const setCombinedVisibility = (showNavigation, showTOC) => {
|
|
2
|
+
// Hide the button when on mobile (and menu us shown as hamburger menu anyways).
|
|
3
|
+
// The exact max-width is taken from the styling of the 'body > header > nav > a' element
|
|
4
|
+
|
|
2
5
|
let style = `
|
|
3
6
|
.mkdocs-toggle-sidebar-button {
|
|
4
7
|
cursor: pointer;
|
|
@@ -6,31 +9,34 @@ const setCombinedVisibility = (showNavigation, showTOC) => {
|
|
|
6
9
|
margin-left: 1rem;
|
|
7
10
|
}
|
|
8
11
|
|
|
9
|
-
/*
|
|
10
|
-
Hide the button when on mobile (and menu us shown as hamburger menu anyways).
|
|
11
|
-
The exact max-width is taken from the styling of the 'body > header > nav > a' element
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
12
|
@media screen and (max-width: 76.1875em) {
|
|
15
13
|
.mkdocs-toggle-sidebar-button {
|
|
16
14
|
display: none;
|
|
17
15
|
}
|
|
18
16
|
}
|
|
19
17
|
`;
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
18
|
+
// The TOC has a different break point than the navigation.
|
|
19
|
+
// It can be seen on the nav.md-nav--secondary:nth-child(1) element (60em)
|
|
20
|
+
// If the screen is smaller, it is shown in the navigation section if you click the nested hamburger menu
|
|
21
|
+
if (!showTOC) {
|
|
22
|
+
style += `
|
|
23
|
+
@media screen and (min-width: 60em) {
|
|
24
|
+
div.md-sidebar.md-sidebar--secondary {
|
|
25
|
+
display: none;
|
|
26
|
+
}
|
|
24
27
|
}
|
|
25
28
|
`;
|
|
26
|
-
|
|
27
|
-
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// We always have to show the navigation in mobile view, otherwise the hamburger menu is broken
|
|
28
32
|
if (!showNavigation) {
|
|
29
33
|
style += `
|
|
30
|
-
|
|
31
|
-
|
|
34
|
+
@media screen and (min-width: 76.1875em) {
|
|
35
|
+
div.md-sidebar.md-sidebar--primary {
|
|
36
|
+
display: none;
|
|
37
|
+
}
|
|
32
38
|
}
|
|
33
|
-
|
|
39
|
+
`;
|
|
34
40
|
}
|
|
35
41
|
|
|
36
42
|
return style;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mkdocs-toggle-sidebar-plugin
|
|
3
|
-
Version: 0.0.
|
|
4
|
-
Summary: Add keybindings to toggle the table of contents
|
|
3
|
+
Version: 0.0.5
|
|
4
|
+
Summary: Add keybindings to toggle the navigation and table of contents sidebars
|
|
5
5
|
Home-page: https://github.com/six-two/mkdocs-toggle-sidebar-plugin
|
|
6
6
|
Author: six-two
|
|
7
7
|
Author-email: pip@six-two.dev
|
|
@@ -114,11 +114,15 @@ Test mkdocs theme:
|
|
|
114
114
|
|
|
115
115
|
## Notable changes
|
|
116
116
|
|
|
117
|
+
### Version 0.0.5
|
|
118
|
+
|
|
119
|
+
- Bug fix: On small screens with the material theme the navigation would be hidden, even when the hamburger menu was opened.
|
|
120
|
+
|
|
117
121
|
### Version 0.0.4
|
|
118
122
|
|
|
119
123
|
- Export API via `MkdocsToggleSidebarPlugin` object.
|
|
120
124
|
This lets you create custom buttons or key bindings to hide, show or toggle the side bars.
|
|
121
|
-
- Added `toggle_button` option and implemented it for Material theme
|
|
125
|
+
- Added `toggle_button` option and implemented it for Material theme.
|
|
122
126
|
|
|
123
127
|
### Version 0.0.3
|
|
124
128
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|