Skip to content

update with new mdbook index.hbs to fix sidebar #8445

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

Merged
merged 1 commit into from
Oct 3, 2023

Conversation

gabydd
Copy link
Member

@gabydd gabydd commented Oct 2, 2023

fixes the sidebar problems after we updated to the latest release of mdbook cc: @zqianem who was the last one to work on this part of the book

Copy link
Member

@the-mikedavis the-mikedavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Odd, I see the odd sidebar behavior on https://docs.helix-editor.com/master/ but not when running locally 🤔

(Upstream template: https://github.com/rust-lang/mdBook/blob/master/src/theme/index.hbs)

@the-mikedavis the-mikedavis added C-bug Category: This is a bug A-documentation Area: Documentation improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Oct 2, 2023
@gabydd
Copy link
Member Author

gabydd commented Oct 2, 2023

Hmm I was able to see it locally maybe you have an older version of mdbook locally I tested with the binary from the latest release. In terms of the upstream template this is just the upstream template with the colibri theme added as one of the theme options, which I believe was the only change for the older template as well

@zqianem
Copy link
Contributor

zqianem commented Oct 2, 2023

The changes look good to me.

It might be a good idea to pin the mdBook version and document that index.hbs needs to be merged from upstream when updating the pin, to avoid breakages like this in the future. We would be able to unpin after rust-lang/mdBook#2059 allows us to avoid overriding index.hbs.

@archseer archseer merged commit 1756ba4 into helix-editor:master Oct 3, 2023
danillos pushed a commit to danillos/helix that referenced this pull request Nov 21, 2023
dgkf pushed a commit to dgkf/helix that referenced this pull request Jan 30, 2024
mtoohey31 pushed a commit to mtoohey31/helix that referenced this pull request Jun 2, 2024
smortime pushed a commit to smortime/helix that referenced this pull request Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements C-bug Category: This is a bug S-waiting-on-review Status: Awaiting review from a maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants