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

Use Bootstrap 5 template for pkgdown website #1209

Merged
merged 2 commits into from
May 24, 2024
Merged

Conversation

IndrajeetPatil
Copy link
Collaborator

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).

@jayhesselberth
Copy link

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.

@lorenzwalthert
Copy link
Collaborator

For reference: r-lib/pkgdown#1960

Indeed I don’t like the default search. Is there another way to do search? What is docsearch?

@jayhesselberth
Copy link

jayhesselberth commented May 15, 2024

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.

@lorenzwalthert
Copy link
Collaborator

Looks like you'll have to choose between BS5 and docsearch. I recommend the former as BS5 support will only continue to improve.

Yeah, I guess that's what we have to do.

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.

Oh, great, are you interested to contribute those for {styler} or upstream in {pgkdown}? :D

@lorenzwalthert
Copy link
Collaborator

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.

@jayhesselberth, any interest? Otherwise I think we'll merge as is.

@jayhesselberth
Copy link

I suggest merging as-is. The next release of pkgdown will have some major improvements for BS5 sites.

Copy link
Collaborator

@lorenzwalthert lorenzwalthert left a 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.

@lorenzwalthert
Copy link
Collaborator

Also, @IndrajeetPatil, can you please make sure that after the merge, the dev docs display as expected on mobile and desktop?

@IndrajeetPatil IndrajeetPatil merged commit 445bf3e into main May 24, 2024
15 checks passed
@IndrajeetPatil IndrajeetPatil deleted the bootstrap-5-pkgdown branch May 24, 2024 16:09
@IndrajeetPatil
Copy link
Collaborator Author

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.

@IndrajeetPatil
Copy link
Collaborator Author

Things mostly look good, except the navbar is a bit too big.
But I'd like to address this after the next pkgdown release, which is going to contain many big changes.

We could also consider using devel-pkgdown to build the website.

@lorenzwalthert
Copy link
Collaborator

Yeah let's wait then.

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

Successfully merging this pull request may close these issues.

3 participants