-
Notifications
You must be signed in to change notification settings - Fork 71
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
Use Bootstrap 5 template for pkgdown website #1209
Conversation
Is docsearch somehow incompatible with BS5 in pkgdown? I don't think that is intended. But maybe you wanted to use the built-in search anyway. |
For reference: r-lib/pkgdown#1960 Indeed I don’t like the default search. Is there another way to do search? What is docsearch? |
Got it. Docsearch is Algolia's product: https://docsearch.algolia.com/ Looks like you'll have to choose between BS5 and docsearch. I recommend the former as BS5 support will only continue to improve. Not sure what it is you don't like about the default search, but the search results from fuse.js — the default pkgdown search — could likely be spruced up with some CSS modifications. |
Yeah, I guess that's what we have to do.
Oh, great, are you interested to contribute those for {styler} or upstream in {pgkdown}? :D |
@jayhesselberth, any interest? Otherwise I think we'll merge as is. |
I suggest merging as-is. The next release of pkgdown will have some major improvements for BS5 sites. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, then let's merge as is and keep an eye on {pkgdown} releases.
Also, @IndrajeetPatil, can you please make sure that after the merge, the dev docs display as expected on mobile and desktop? |
Yes, will check once the websites are built. |
Things mostly look good, except the navbar is a bit too big. We could also consider using devel-pkgdown to build the website. |
Yeah let's wait then. |
BS3 is being deprecated in pkgdown.
But, even if that were not the case, the website has a lot to gain from this switch, and not much to lose (I recall you not being happy with the search feature). The BS3 look is quite cumbersome (e.g. try reading this vignette on mobile browser).