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

The view button and footer (previous and next buttons) doesn't show up #4760

Closed
4 of 5 tasks
krahets opened this issue Dec 14, 2022 · 6 comments
Closed
4 of 5 tasks
Labels
bug Issue reports a bug needs reproduction Issue lacks a minimal reproduction .zip file

Comments

@krahets
Copy link

krahets commented Dec 14, 2022

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

I've updated the package to 9.00b4. The new search is awesome, thanks!

The view button and footer (previous and next buttons) don't show up after setting the arguments described in #4714.

Do I miss anything?

theme:
  features:
    - content.action.edit
    - content.action.view
    - navigation.footer

Expected behaviour

The view button and footer (previous and next buttons)

Actual behaviour

Not showed up

Steps to reproduce

mkdocs serve

Package versions

  • Python: 3.7
  • MkDocs: 1.4.2
  • Material: 9.0.0b4

Configuration

# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  language: zh
  features:
    # - announce.dismiss
    - content.action.edit
    # - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    # - navigation.tabs
    # - navigation.tabs.sticky
    # - navigation.top
    - navigation.footer
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

System information

  • Operating system: macOS
  • Browser: Chrome
@squidfunk
Copy link
Owner

squidfunk commented Dec 14, 2022

Thanks for reporting. Did you set repo_url as mentioned in #4714? Also make sure to remove your overrides when reporting issues, because the error might be in them.

@squidfunk squidfunk added the needs input Issue needs further input by the reporter label Dec 14, 2022
@squidfunk
Copy link
Owner

squidfunk commented Dec 14, 2022

I've verified. The following configuration definitely works on the latest beta:

site_name: My Docs
repo_url: https://github.com/squidfunk/mkdocs-material
theme:
  name: material
  features:
    - content.action.edit
    - content.action.view

Closing as not reproducible.

@squidfunk squidfunk added bug Issue reports a bug needs reproduction Issue lacks a minimal reproduction .zip file and removed needs input Issue needs further input by the reporter labels Dec 14, 2022
@HonkingGoose
Copy link
Contributor

HonkingGoose commented Dec 19, 2022

Note
This problem is fixed for me with the official 9.0.0 release. 🥳

Intro

I don't see any new "view source" button. The "edit source" button is visible and working. The navigation footer works (after opting in again).

I've installed the latest mkdocs-material = "==9.0.0b4" beta, and followed these steps in the beta announcement issue:

  • Enable edit and view source button: a "view source" button can be shown next to the "edit this page" button, both of which must now be explicitly enabled. The repo_url must also be given. Add the following lines to mkdocs.yml:

    repo_url: ...
    theme:
      features:
        - content.action.edit
        - content.action.view

Removed overrides

Also make sure to remove your overrides when reporting issues, because the error might be in them.

I've deleted the override folder and the override section in the mkdocs.yml file. I already set the repo_url.

Reproduction repository

You can open my branch on GitHub Codespaces to see for yourself. 😉 Here's how:

  1. Open my branch in GitHub Codespaces: https://github.com/HonkingGoose/renovatebot.github.io/tree/reproduction-for-material-maintainer
  2. Wait for the setup task to complete
  3. Run make serve to run the test server
  4. Open preview server in browser
  5. There's no "view source" button on the homepage

@squidfunk
Copy link
Owner

squidfunk commented Dec 19, 2022

Please try this on a mint installation of 9.0.0b4 and see if the issue persists. If it does, check if you need to update your overrides. View and edit button, as well as the footer definitely work, they are now opt-in however.

If that doesn't work please provide a minimal reproduction. It saves me time trying to get your huge reproduction to work.

@HonkingGoose
Copy link
Contributor

Please try this on a mint installation of 9.0.0b4 and see if the issue persists. If it does, check if you need to update your overrides. View and edit button, as well as the footer definitely work, they are now opt-in however.

Good news: the "edit source" and "view source" buttons work on the official v9 release. 🥳

If that doesn't work please provide a minimal reproduction. It saves me time trying to get your huge reproduction to work.

Yeah that's fair. I could not get a minimal reproduction going for this problem. In any case it's fixed now. 😄

@squidfunk
Copy link
Owner

Glad to hear. Note that reproductions are now mandatory for every bug report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue reports a bug needs reproduction Issue lacks a minimal reproduction .zip file
Projects
None yet
Development

No branches or pull requests

3 participants