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

feat: use _brand.yml for pkgdown #1176

Merged
merged 4 commits into from
Jan 29, 2025
Merged

feat: use _brand.yml for pkgdown #1176

merged 4 commits into from
Jan 29, 2025

Conversation

gadenbuie
Copy link
Member

No description provided.

@@ -247,38 +247,4 @@ footer {
img:active {
opacity: 1;
}

// github-dark.css //
Copy link
Member Author

Choose a reason for hiding this comment

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

No longer needed, pkgdown supports template.theme-dark

link-color: "#216B73"
link-color-dark: "#cef4f9"
link-decoration: underline dotted
brand: pkgdown/_brand.yml
Copy link
Member Author

Choose a reason for hiding this comment

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

pkgdown renders from the root folder, so we wouldn't need this if we had _brand.yml in the package root. (We wouldn't even need bslib.brand, but we could force it with bslib.brand: true.)

In our case, however, we don't want our example or test apps to accidentally pick up _brand.yml, so I've moved both it and _pkgdown.yml into pkgdown/. I can undo moving _pkgdown.yml if you want, but I generally prefer to keep all pkgdown things there.

Comment on lines -22 to -24
docsearch:
api_key: 53fd87c79a13e431b4298611470d023a
index_name: bslib
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm pretty certain we're using pkgdown's built in search these days.

defaults:
bootstrap:
defaults:
link-color-dark: "#cef4f9"
Copy link
Member Author

Choose a reason for hiding this comment

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

This is a good argument for color and background-color to take light/dark variants in brand.yml (something we'll think about doing in the future).

typography:
  link:
    color:
      light: "#216b73"
      dark: "#cef4f9"

@gadenbuie gadenbuie requested a review from cpsievert January 28, 2025 21:58
pkgdown/_brand.yml Outdated Show resolved Hide resolved
@gadenbuie gadenbuie merged commit c2bdb0b into main Jan 29, 2025
12 of 13 checks passed
@gadenbuie gadenbuie deleted the brand/pkgdown branch January 29, 2025 18:05
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.

2 participants