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

Support for Quarto 1.6 _brand.yml #1483

Open
marcusinthesky opened this issue Dec 31, 2024 · 0 comments
Open

Support for Quarto 1.6 _brand.yml #1483

marcusinthesky opened this issue Dec 31, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@marcusinthesky
Copy link

marcusinthesky commented Dec 31, 2024

In the Quarto 1.6 release, support for a _brand.yml was added, based on the brand.yml specification.

Minimally reproducible example

Creating Repository

A public repository has been made available, with a working Github Pages URL, based on the commands below:

  1. We create a new nbdev repository:
nbdev_new
  1. We create a _brand.yml, based on the example given in Quarto's Documentation:
cat <<EOF >> nbs/_brand.yml
color:
  palette:
    dark-grey: "#222222"
    blue: "#ddeaf1"
  background: blue
  foreground: dark-grey
  primary: black

typography:
  fonts:
    - family: Jura
      source: google
  base: Jura
  headings: Jura
EOF
  1. We then look at the docs (install the hooks, or view static rendered documentation):
nbdev_preview

Expected Behavior

We expect to see the correct fonts and background colors applied to the documentation:
Screenshot from 2024-12-31 11-38-10

Current Issue

Currently, the _brand.yml is not being copied across from the ./nbs directory, where the _quarto.yml, sidebar.yml and custom.yml are stored, to the ./_proc directory:
image
While these file can be copied across manually, the _proc directory is temporary, and is unexpected behavior, given the nbdev documentation on website customization:

"file in the same location as your _quarto.yml file to override any values in _quarto.yml"

Possible Fixes

Similar to changes made the the extensions directory, released in 2.3.11, a single line could be added to nbs/api/serve.ipynb:

if (path/'_brand.yml').exists(): files.append(path/'_brand.yml')

see: #1484

@marcusinthesky marcusinthesky added the bug Something isn't working label Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant