quarto-ext / fontawesome

Use Font Awesome icons in HTML and PDF documents.
MIT License
105 stars 10 forks source link

Make icons available to use in `_quarto.yml` #6

Open mine-cetinkaya-rundel opened 2 years ago

mine-cetinkaya-rundel commented 2 years ago

Once the extension is installed in the project it would be great to be able to use them in _quarto.yml as well, e.g., for tools.

mcanouil commented 2 years ago

It's already working. I added the lemon FA icon to the title within your _quarto.yml. Did you mean something else?

Screenshot 2022-07-17 at 10 49 45
mine-cetinkaya-rundel commented 2 years ago

It did not work as an icon in the navbar, for example instead of rss-fill.

mcanouil commented 2 years ago

I believe this and #7 (after looking more in the code) to be more a Quarto issue than an issue within the extension itself.

B0ydT commented 2 years ago

I looked at the rlille.fr site maintained by @mcanouil when building mine, looking for reasons his icons were showing up in the nav bar but mine weren't.

The only difference I could find was that he included this line in his styles.css file and I didn't. I'm not an expert so I don't quite know why it works, but it fixed my problem.

/* @import url(https://use.fontawesome.com/releases/v6.1.1/css/all.css); */

mcanouil commented 2 years ago

This was a test before Quarto extensions. The complete file is actually "empty" (only comments in there) https://github.com/RLille/rlille.fr/blob/main/styles.css

To note, icons are included via shortcodes, thus in the text keys.

https://github.com/RLille/rlille.fr/blob/5354264ece5b32cfa9a1dab0ce0b58faad45c071/_quarto.yml#L35-L50

B0ydT commented 2 years ago

Oops, you're totally right, and I'm totally misremembering when it started working!

What actually worked for me was swapping the icon tag used for the base icons with a text tag. Of the 3 examples below, the first and third work, while the second does not:

website:
  title: "Example"
  navbar:
    right:
      - icon: twitter
        href: https://twitter.com/bioboyd
      - icon: "{{< fa brands twitter >}}"
        href: https://twitter.com/bioboyd
      - text: "{{< fa brands twitter >}}"
        href: https://twitter.com/bioboyd
mcanouil commented 2 years ago

icon keys are parsed specifically to handle one icon library/version. While text keys are processed as regular markdown/raw code, leading to 1/3 working but not 2, in your last example.

@mine-cetinkaya-rundel did you use the shortcode in text keys for the navbar or elsewhere, when it did not worked?

naupaka commented 1 year ago

Thanks @B0ydT for the tip -- works great as text!

Paulj1989 commented 1 year ago

Hi folks, has anyone had any luck getting font awesome icons into the sidebar tools of a Quarto book? I've been fiddling with this for a while, and have followed the suggestions here, and don't seem to be able to get it working. I've used the following code:

sidebar:
    tools:
      - text: "{{< fa brands python >}}"

I've tried a few different things, including a few different icons (to make sure the issue isn't specific to certain subsets of icons) and testing the same approach in the navbar (works fine).

It's possible I'm missing something, but if anyone has any suggestions that would be much appreciated!

mcanouil commented 1 year ago

I would suggest to follow https://github.com/quarto-dev/quarto-cli/issues/6359 because the issue here can't be adresse within the extension.

Paulj1989 commented 1 year ago

Alright, thanks for the heads up @mcanouil!