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

Section Headings #43

Open
lornajane opened this issue Jun 24, 2021 · 4 comments
Open

Section Headings #43

lornajane opened this issue Jun 24, 2021 · 4 comments
Labels
enhancement New feature or request

Comments

@lornajane
Copy link

Is your feature request related to a problem? Please describe.

I would love to be able to add plain text labels or section headings into my navigation. Right now I have "pointless" pages that just make the navigation folding for another section work. I'd appreciate a plain text option, for example we have a subsection "concepts" that holds too much stuff to have open by default but I have to have a "concepts" page that performs no actual purpose, it's just to make the navigation work.

Describe the solution you'd like

Have an option to have a plain text entry instead of a link. If it has children, it's collapsible. So like an entry that only has the title field to display, but doesn't link anywhere.

Describe alternatives you've considered

Going back to maintaining all those toctree entrires in all my files to get the section heading feature. Doing what I have now with a page that just displays the tables of contents or some sort of introduction to a navigation section.

If there are more alternatives, I'm happy to hear about possible workarounds

@lornajane lornajane added the enhancement New feature or request label Jun 24, 2021
@welcome
Copy link

welcome bot commented Jun 24, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@chrisjsewell
Copy link
Member

Thanks!
To note, this came out of a discussion on Slack, so I understand the use case here and agree it would be a nice addition

@trulede
Copy link

trulede commented Aug 10, 2021

I've encountered a similar thing:

---
root: intro.md
defaults:
  titlesonly: True
subtrees:
  - caption: Schemas
    titlesonly: False
    entries:
      - file: schemas/flatbuffers/__index__.md   <<<< This file does nothing, just wanted a grouping in the TOC
        subtrees:
          - entries:
              - glob: schemas/flatbuffers/*``    <<<< Content is here

Before I read the manual, I did think this might work:

---
root: intro.md
defaults:
  titlesonly: True
subtrees:
  - caption: Schemas
    titlesonly: False
    entries:
      - caption: Flatbuffers
        subtrees:
          - entries:
              - glob: schemas/flatbuffers/*

@lornajane
Copy link
Author

I'm still struggling with this, which is regularly reported as a problem with our documentation. I can nearly do this by making every level of nesting into a subtree, and adding a caption for the subtree. This looks all right in the .. tableofcontents output, but seems to be ignored by the left-hand navigation itself. I know a bunch of people have run into this so just sharing my findings as I go along, in case it helps anyone!

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

No branches or pull requests

3 participants