What is the purpose of description YAML option?
#6055
-
|
The Quarto reference for enlists the Where does the value stored in this option get used in the webpage? (The reference mentions this option among those that "affect website output", hence asking.) |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 6 replies
-
|
The description could appear in a couple of places:
HTH! [edit below] The above is true for the When placed under the |
Beta Was this translation helpful? Give feedback.
-
|
Project metadata isn’t considered a part of document metadata currently, so keys such as book and website aren’t available at the document level for the meta shortcode right now… |
Beta Was this translation helpful? Give feedback.
-
|
But I have the following observation:
project:
type: website
website:
title: "my website"
format:
html:
theme: cosmo
css: styles.css
toc: true
---
title: "index title"
---
{{< meta website.title >}}This doesn't give any error (unlike This suggests that the variable |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for finding this - you are correct that |
Beta Was this translation helpful? Give feedback.
-
|
@dragonstyle FYI the issue about shortcode was already discussed elsewhere: #6049 (comment) |
Beta Was this translation helpful? Give feedback.
-
|
Thanks! There are really two issue in play here:
|
Beta Was this translation helpful? Give feedback.
The description could appear in a couple of places:
It will be used as the
metadescription for the HTML page. Check the<head>tags to see this.HTML title blocks may display the description as well.
HTH!
[edit below]
The above is true for the
descriptionkey appearing in a document. You're asking more specifically about it appearing in_quarto.ymlunderwebsite(sorry I didn't catch that on first reading).When placed under the
websitekey, it looks like we use that for the description that appears within any RSS feed generated for the website (if no description is available on the page which generated the RSS feed).