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

[BUG] Sidebar Depth FAQ #71

Closed
ghost opened this issue Aug 5, 2019 · 5 comments
Closed

[BUG] Sidebar Depth FAQ #71

ghost opened this issue Aug 5, 2019 · 5 comments
Labels
bug Technical mistake help wanted Extra attention is needed structure Regarding the structure of VuePress and GitHub visual Regarding the UI of the documentation

Comments

@ghost
Copy link

ghost commented Aug 5, 2019

the config.js file has sidebarDepth: 2 for all the pillars, including the FAQ, I also tested with adding this header to the FAQ files:

---
sidebarDepth: 2
---

But regardless, the FAQ-Contribution.md, FAQ-Installation.md, FAQ-Introduction.md files do not show the headers with ## or ### in the sidebar.

This bug comes up when there are only # and ### headers in the file, and no ## headers. Thus it can be fixed when adding at least one ## headers to the file. Yet is there a proper fix so that it does diplay ### headers when there are no ## headers?

@ghost ghost added help wanted Extra attention is needed visual Regarding the UI of the documentation bug Technical mistake structure Regarding the structure of VuePress and GitHub labels Aug 5, 2019
@ghost
Copy link
Author

ghost commented Aug 5, 2019

18ca45c this adds ## headers to the above mentioned files, and thus fixes the bug - but only kind-off, and not properly.

@dennisreimann
Copy link
Contributor

This seems to be a bug and it affects the table of contents as well. Seems like something in the VuePress internal data structure requires a proper heading level incrementation.

@ghost
Copy link
Author

ghost commented Aug 6, 2019

Something that we [haha, you] can fix, or is this a bug for upstream?

@dennisreimann
Copy link
Contributor

This should be done upstream. I found this issue which describes the bug: vuejs/vuepress#1399

@ghost
Copy link
Author

ghost commented Aug 9, 2019

Although the underlying bug is still present, because we now use the ## headers as well, it is no longer present in this repo.
There might be some new issues regarding #79, but that might not be merged at all...

Thus, closing this issue.

@ghost ghost closed this as completed Aug 9, 2019
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Technical mistake help wanted Extra attention is needed structure Regarding the structure of VuePress and GitHub visual Regarding the UI of the documentation
Projects
None yet
Development

No branches or pull requests

1 participant