Skip to content

Commit 4acdadb

Browse files
Update reference pages (prerelease) (#2309)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent fb1b866 commit 4acdadb

11 files changed

Lines changed: 70 additions & 39 deletions

File tree

‎docs/cli/cli-info.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.11.6",
2+
"version": "1.11.7",
33
"commands": [
44
{
55
"name": "render",

‎docs/reference/cells/cells-jupyter.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1390,8 +1390,10 @@
13901390
},
13911391
{
13921392
"name": "fig-alt",
1393-
"description": "Alternative text to be used in the `alt` attribute of HTML images.\n",
1393+
"description": "Alternative text for figures, distinct from their visible caption.\n",
13941394
"formats": [
1395+
"docx",
1396+
"typst",
13951397
"dashboard",
13961398
"html",
13971399
"html4",
@@ -1403,7 +1405,10 @@
14031405
"dzslides",
14041406
"epub",
14051407
"epub2",
1406-
"epub3"
1408+
"epub3",
1409+
"latex",
1410+
"pdf",
1411+
"beamer"
14071412
]
14081413
},
14091414
{

‎docs/reference/cells/cells-knitr.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2631,8 +2631,10 @@
26312631
},
26322632
{
26332633
"name": "fig-alt",
2634-
"description": "Alternative text to be used in the `alt` attribute of HTML images.\n",
2634+
"description": "Alternative text for figures, distinct from their visible caption.\n",
26352635
"formats": [
2636+
"docx",
2637+
"typst",
26362638
"dashboard",
26372639
"html",
26382640
"html4",
@@ -2644,7 +2646,10 @@
26442646
"dzslides",
26452647
"epub",
26462648
"epub2",
2647-
"epub3"
2649+
"epub3",
2650+
"latex",
2651+
"pdf",
2652+
"beamer"
26482653
]
26492654
},
26502655
{

‎docs/reference/cells/cells-ojs.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1244,8 +1244,10 @@
12441244
},
12451245
{
12461246
"name": "fig-alt",
1247-
"description": "Alternative text to be used in the `alt` attribute of HTML images.\n",
1247+
"description": "Alternative text for figures, distinct from their visible caption.\n",
12481248
"formats": [
1249+
"docx",
1250+
"typst",
12491251
"dashboard",
12501252
"html",
12511253
"html4",
@@ -1257,7 +1259,10 @@
12571259
"dzslides",
12581260
"epub",
12591261
"epub2",
1260-
"epub3"
1262+
"epub3",
1263+
"latex",
1264+
"pdf",
1265+
"beamer"
12611266
]
12621267
},
12631268
{

‎docs/reference/formats/html.json‎

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -744,29 +744,53 @@
744744
"name": "repo-actions",
745745
"description": "Setting this to false prevents the `repo-actions` from appearing on this page.\nOther possible values are `none` or one or more of `edit`, `source`, and `issue`, *e.g.* `[edit, source, issue]`.\n"
746746
},
747+
{
748+
"name": "bread-crumbs",
749+
"description": "Setting this to false hides the navigation breadcrumbs on this page."
750+
},
751+
{
752+
"name": "back-to-top-navigation",
753+
"description": "Setting this to false hides the 'back to top' navigation button on this page."
754+
},
755+
{
756+
"name": "page-navigation",
757+
"description": "Show (`true`) or hide (`false`) the next and previous page links in the footer of this page."
758+
},
759+
{
760+
"name": "margin-header",
761+
"description": "Markdown to place above margin content on this page (text or file path), after the `website` margin header."
762+
},
763+
{
764+
"name": "margin-footer",
765+
"description": "Markdown to place below margin content on this page (text or file path), after the `website` margin footer."
766+
},
747767
{
748768
"name": "aliases",
749769
"description": "URLs that alias this document, when included in a website."
750770
},
751771
{
752772
"name": "image",
753-
"description": "The path to a preview image for this content. By default, \nQuarto will use the image value from the site: metadata. \nIf you provide an image, you may also optionally provide \nan image-width and image-height to improve \nthe appearance of your Twitter Card.\n\nIf image is not provided, Quarto will automatically attempt \nto locate a preview image.\n"
773+
"description": "The path to a preview image for this content. By default, \nQuarto will use the image value from the `website` metadata.\nTo declare the size of the preview image for Open Graph,\nset `image-width` and `image-height` under `open-graph`.\n\nIf image is not provided, Quarto will automatically attempt\nto locate a preview image.\n"
774+
},
775+
{
776+
"name": "image-alt",
777+
"description": "The alt text for preview image on this page."
754778
},
755779
{
756-
"name": "image-height",
757-
"description": "The height of the preview image for this document."
780+
"name": "image-title",
781+
"description": "The title for the main image on the about page. Used when\n`about` does not set its own `image-title`.\n"
758782
},
759783
{
760-
"name": "image-width",
761-
"description": "The width of the preview image for this document."
784+
"name": "open-graph",
785+
"description": "Publish open graph metadata for this page. Options set here are merged\nwith the `open-graph` options of the `website` metadata. Set to `false`\nto omit open graph metadata from this page.\n"
762786
},
763787
{
764-
"name": "image-alt",
765-
"description": "The alt text for preview image on this page."
788+
"name": "twitter-card",
789+
"description": "Publish twitter card metadata for this page. Options set here are merged\nwith the `twitter-card` options of the `website` metadata. Set to `false`\nto omit twitter card metadata from this page.\n"
766790
},
767791
{
768792
"name": "image-lazy-loading",
769-
"description": "Enables lazy loading for the preview image. If true, the preview image element \nwill have `loading=\"lazy\"`, and will only load when it comes into view.\n\nIf false, the preview image will load immediately.\n"
793+
"description": "Enables lazy loading for this page's image when the page appears as an item\nin a listing. If true, the listing image element will have `loading=\"lazy\"`,\nand will only load when it comes into view.\n\nIf false, the image will load immediately. This overrides the listing's\n`image-lazy-loading` option for this item.\n"
770794
}
771795
]
772796
},

‎docs/reference/metadata/brand.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@
228228
},
229229
{
230230
"name": "files",
231-
"description": "The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
231+
"description": "A list of font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
232232
}
233233
]
234234
},

‎docs/reference/projects/book.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@
545545
},
546546
{
547547
"name": "image",
548-
"description": "Default site thumbnail image for `twitter` /`open-graph`\n"
548+
"description": "Default site thumbnail image for `twitter` /`open-graph`, relative to the project directory.\n"
549549
},
550550
{
551551
"name": "image-alt",

‎docs/reference/projects/feed.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
},
1414
{
1515
"name": "image",
16-
"description": "The path to an image for this feed. If not specified, the image for the page the listing \nappears on will be used, otherwise an image will be used if specified for the site \nin the Quarto project.\n"
16+
"description": "The path to an image for this feed. If not specified, the image for the page the listing \nappears on will be used, otherwise an image will be used if specified for the site \nin the Quarto project. A relative path set in the listing page front matter is relative to the project directory.\n"
1717
},
1818
{
1919
"name": "description",

‎docs/reference/projects/open-graph.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,11 @@
99
},
1010
{
1111
"name": "image",
12-
"description": "The path to a preview image for the content. By default, Quarto will use\nthe `image` value from the format metadata. If you provide an \nimage, you may also optionally provide an `image-width` and `image-height`.\n"
12+
"description": "The path to a preview image for the content. By default, Quarto will use\nthe `image` value from the format metadata.\n"
1313
},
1414
{
1515
"name": "image-alt",
16-
"description": "The alt text for the preview image. By default, Quarto will use\nthe `image-alt` value from the format metadata. If you provide an \nimage, you may also optionally provide an `image-width` and `image-height`.\n"
17-
},
18-
{
19-
"name": "image-width",
20-
"description": "Image width (pixels)"
21-
},
22-
{
23-
"name": "image-height",
24-
"description": "Image height (pixels)"
16+
"description": "The alt text for the preview image. By default, Quarto will use\nthe `image-alt` value from the format metadata.\n"
2517
},
2618
{
2719
"name": "locale",
@@ -30,5 +22,13 @@
3022
{
3123
"name": "site-name",
3224
"description": "Name that should be displayed for the overall site. If not explicitly \nprovided in the `open-graph` metadata, Quarto will use the website or\nbook `title` by default.\n"
25+
},
26+
{
27+
"name": "image-width",
28+
"description": "Image width (pixels)"
29+
},
30+
{
31+
"name": "image-height",
32+
"description": "Image height (pixels)"
3333
}
3434
]

‎docs/reference/projects/twitter.json‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,11 @@
99
},
1010
{
1111
"name": "image",
12-
"description": "The path to a preview image for the content. By default, Quarto will use\nthe `image` value from the format metadata. If you provide an \nimage, you may also optionally provide an `image-width` and `image-height`.\n"
12+
"description": "The path to a preview image for the content. By default, Quarto will use\nthe `image` value from the format metadata.\n"
1313
},
1414
{
1515
"name": "image-alt",
16-
"description": "The alt text for the preview image. By default, Quarto will use\nthe `image-alt` value from the format metadata. If you provide an \nimage, you may also optionally provide an `image-width` and `image-height`.\n"
17-
},
18-
{
19-
"name": "image-width",
20-
"description": "Image width (pixels)"
21-
},
22-
{
23-
"name": "image-height",
24-
"description": "Image height (pixels)"
16+
"description": "The alt text for the preview image. By default, Quarto will use\nthe `image-alt` value from the format metadata.\n"
2517
},
2618
{
2719
"name": "card-style",

0 commit comments

Comments
 (0)