squidfunk / mkdocs-material

Documentation that simply works

Home Page:https://squidfunk.github.io/mkdocs-material/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Navigation pane scrolling not possible for some sections

ashlymat opened this issue · comments

Contribution guidelines

I've found a bug and checked that ...

  • ... the problem doesn't occur with the mkdocs or readthedocs themes
  • ... the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • ... the documentation does not mention anything about my problem
  • ... there are no open or closed issues that are related to my problem

Description

Our documentation is a collection of md files and we notice that for some sections , the scrolling bar in the navigation pane disappears. When scrolled only main page is scrolling.

Expected behaviour

User should be able to scroll navigation pane for all sections

Actual behaviour

The navigation pane is enabled for some sections:
Screenshot 2022-06-27 at 11 41 30

while it is disabled and not scrollable for some sections:
Screenshot 2022-06-27 at 11 42 39

Steps to reproduce

  1. Go to our documentation https://www.project-piper.io
  2. Click on section "Library Steps"
  3. Click on the step "abapEnvironmentAssemblePackages"
  4. Try to scroll left pane to look for more steps below it
  5. This will scroll only the main page but not the navigation pane

Note: This is seen to happen for most of the steps and the only way to come out is to click on other sections (For eg., Extensibility section) and come back to "Library steps".
Also this does not seem to happen for other sections or some sections inside "Library steps"

The only difference I see is with respect to TOC. The sections which are not working seem to have lot of TOC.

Package versions

  • Python: 3.10.5
  • MkDocs: 1.3.0
  • Material: 8.3.6

Configuration

https://github.com/SAP/jenkins-library/blob/master/documentation/mkdocs.yml

System information

  • Operating system: Mac OS
  • Browser: Safari

Thanks for reporting. What you're observing is a symptom of Material for MkDocs not being able to fully initialize. You're using an outdated configuration for pymdownx.tabbed. When migrating to a new major version, please always check the migration guide and make sure to apply all necessary changes, respectively this one.

Bildschirmfoto 2022-06-27 um 12 15 37