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

First Class Support for Table of Contents in Projects #1113

Closed
jdcast opened this issue May 29, 2019 · 1 comment
Closed

First Class Support for Table of Contents in Projects #1113

jdcast opened this issue May 29, 2019 · 1 comment

Comments

@jdcast
Copy link

jdcast commented May 29, 2019

I see that it's possible to add a toc to any page in general via this feature request.

However, adding a toc in this way to a project page (my end goal) simply keeps the toc statically placed at the top of the page; the toc scrolls out of view in longer project pages.

I've noticed the toc behavior and placement is nicer in the docs page.
It would be great to emulate this behavior and placement in project pages as well.

@jdcast jdcast changed the title Stationary Side Pane for Table of Contents in Projects First Class Support for Table of Contents in Projects May 29, 2019
@gcushen
Copy link
Collaborator

gcushen commented May 30, 2019

For general pages, there is the TOC shortcode. For pages with the docs layout, there is the additional option of TOC sidebar.

The layout for docs is entirely different and it would be complicated and generally unnecessary to integrate it into projects.

You can however create your project content using the docs layout and link to it from other pages by using the front matter option links to generate a link button to the relevant page. You will loose the project specific functionality this way though.

@gcushen gcushen closed this as completed May 30, 2019
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

2 participants