Skip to content

docs: missing navigation on small/medium viewports #87

@joestrouth1

Description

@joestrouth1

The docs feel frustrating to navigate in anything other than a large browser window. When I view the Spark docs there, I can see a list of docs pages on the left and a table of contents for the current page on the right.

Image

On smaller viewports like a half-width window, tablet, or phone, those disappear. The docs nav on the left hides at <1220px wide and the table of contents goes away at <960px wide. The logo also disappears.

Hidden nav at medium viewports

Hidden table of contents at small viewports

I can see there is a drawer navigation by poking around in dev tools, but there's no obvious "Menu" button to make it appear. If I check a hidden input, it slides in:

Image

I read through the Material for MKDocs docs section on Navigation and didn't see any options related to this responsive behavior. There are options to hide the nav/ToC but I only saw those used on the homepage. Removing them from index.md did not help. Didn't see anything fishy in the extra spark.css stylesheet or mkdocs.yml either.


I don't see anything that looks like a template file for docs pages or the site header. If MKDocs or the material theme the site uses supports that, one could add a menu/ToC button there. I know MKDocs supports loading extra javascript, where one could create a button that appears only on small viewports and toggles the input[type=checkbox] responsible for controlling the drawer.

The drawer as it exists today doesn't use the logo/wordmark visible in the global nav, but would at least offer navigation.

Expected

I can navigate within the article I'm viewing and between docs pages on small screens or when splitting my display between docs+project.

Actual

I must click 'Docs' in the header to get back to the Getting Started page, then scroll to the bottom and find the link I'd like to go to.

Steps to reproduce

  1. Navigate to the SparkRenderer docs page in a viewport <1220px wide
  2. Try to navigate to the SparkViewpoint docs page

browser: Chrome Version 138.0.7204.50 (Official Build) (arm64)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions