Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Material no longer rendering awesome-pages config correctly #2472

Closed
rieger-jared opened this issue Mar 18, 2021 · 6 comments
Closed

Material no longer rendering awesome-pages config correctly #2472

rieger-jared opened this issue Mar 18, 2021 · 6 comments

Comments

@rieger-jared
Copy link

Description

Hi, I've been using awesome-pages for a while now, but only with material docs v4.
I tried upgrading to v7 but even the latest awesome-pages does not render out like the old way. Is there something wrong with my config or is this a clash with material docs.

What's interesting is that the ordering is actually still working

I've created a sibling card on awesome-pages lukasgeiter/mkdocs-awesome-pages-plugin#41

.pages

nav:
  - index.md
  - ...
  - contributing.md

Old material docs
Screenshot 2021-03-18 at 11 06 16 pm

new
Screenshot 2021-03-18 at 11 06 49 pm

all links are tabs now
Screenshot 2021-03-18 at 11 07 07 pm

Expected behavior

I expect with the supplied .pages config, that my tab are rendered like the first image

Actual behavior

See image 3, the last image

Steps to reproduce the bug

  1. Set up directory with with the following structure
docs
├── contributing.md
├── developement\
├── getting-started.md
├── guides\
├── img\
├── index.md
├── office\
├── operations
  1. place other md files in sub dirs
  2. run mkdocs serve

Package versions

  • Python: Python 3.9.2
  • MkDocs: mkdocs, version 1.1.2
  • Material: Version: 7.0.6
mkdocs==1.1.2
mkdocs-awesome-pages-plugin==2.5.0
mkdocs-git-revision-date-plugin==0.3.1
mkdocs-material==7.0.6
mkdocs-material-extensions==1.0.1

Project configuration

static_templates:
  - 404.html

# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true

theme:
  icon:
    repo: fontawesome/brands/git-alt
  name: 'material'
  palette:
    scheme: preference
    primary: 'deep orange'
    accent: 'light blue'
  features:
    - navigation.instant
    - navigation.tabs

extra:
  social:
    - icon: fontawesome/brands/github
      link: site
    - icon: fontawesome/brands/slack
      link: site

docs_dir: src

site_dir: 'target/'

plugins:
  - search
  - awesome-pages
  - git-revision-date

# Extensions
markdown_extensions:
  - meta
  - smarty
  - admonition
  - codehilite
  - footnotes
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Required to load the MathJax javascript for the mdx_math.py
extra_javascript:
  ['https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML']

System information

  • OS: MacOS BigSur 11.2.2
  • Browser: Chrome
@squidfunk
Copy link
Owner

Thanks for reporting. The tab grouping semantics changed in 6.2, as explained in #2125 (comment). With this in mind, it’s working as intended 😉

@rieger-jared
Copy link
Author

Oh 😥

That kinda sucks. Would the the insiders indexing fix this? What would awesome pages have to implement to get the behaviour back?

@squidfunk
Copy link
Owner

squidfunk commented Mar 19, 2021

Have you read the comment I linked? It explains how to achieve the same result >= 6.2.

The code example applies to the community edition as it does to Insiders. It was merged some time ago.

@squidfunk
Copy link
Owner

Closing, as it’s working as intended.

@rieger-jared
Copy link
Author

Yeah I did, however it appears this is an awesome-pages issue as the supplied nav fix doesn't work. This isn't then a mkdocs issue but rather an awesome-pages issue. I'll notify the developers of that plugin.

@Andre601
Copy link
Contributor

As it was mentioned in the Awesome pages issue, is a simple fix to just make a folder in the docs directory and add the pages there.
I myself use Both and never encountered this issue so far.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants