quarto-dev / quarto-dev/quarto-cli

documentation error on navigation menu in revealjs

Open
#3,376 1 comment 0 reactions 1 assignee View on GitHub

@cscheid is already working on this.

Since Nov 18, 2022.

enhancement revealjs
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

At https://quarto.org/docs/presentations/revealjs/presenting.html, there is a section on the Navigation Menu. It gives an example of the side, width and number options:

format:
  revealjs:
    side: right
    width: wide

However, this does not seem to work. Autocompletion in the yaml header also doesn't mention these options. Well, it does mention the width option, but that's for the overall presentation, not the nav menu.

Borrowing from the documentation for revealjs in RMarkdown (https://github.com/rstudio/revealjs), this does seem to work:

format:
  revealjs:
    menu:
      side: right
      width: wide

However, this implementation seems to obliviate the option to not show the hamburger, which is done as follows:

format:
  revealjs:
  menu: false

because you can either give menu: false OR menu: <<options on following lines>> in the yaml section. There is no option for not showing the hamburger thingy AND having options for the case where you do want to open the menu (hitting the M key).

So, two things:

  • There's an error in the documentation
  • A suboption in the menu option list (besides side, width, numbers and use-text-content-for-missing-titles) for not showing the hamburger would be nice (e.g., show-hamburger: true/false).

To be clear, the second bullet refers to something like this:

format:
  revealjs:
    menu:
      side: right
      width: wide
      show-hamburger: false

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.