Skip to content

Commit 0da3135

Browse files
cwickhamcwickham
authored
Update reference for 1.7 (#1633)
* Update reference * More updates
1 parent f46dde6 commit 0da3135

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+307
-207
lines changed

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

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,78 @@
147147
"dashboard"
148148
]
149149
},
150+
{
151+
"name": "renderings",
152+
"description": "Array of rendering names, e.g. `[light, dark]`",
153+
"formats": [
154+
"asciidoc",
155+
"asciidoctor",
156+
"beamer",
157+
"biblatex",
158+
"bibtex",
159+
"chunkedhtml",
160+
"commonmark",
161+
"commonmark_x",
162+
"context",
163+
"csljson",
164+
"docbook",
165+
"docbook4",
166+
"docbook5",
167+
"docx",
168+
"dokuwiki",
169+
"dzslides",
170+
"epub",
171+
"epub2",
172+
"epub3",
173+
"fb2",
174+
"gfm",
175+
"haddock",
176+
"html",
177+
"html4",
178+
"html5",
179+
"icml",
180+
"ipynb",
181+
"jats",
182+
"jats_archiving",
183+
"jats_articleauthoring",
184+
"jats_publishing",
185+
"jira",
186+
"json",
187+
"latex",
188+
"man",
189+
"markdown",
190+
"markdown_github",
191+
"markdown_mmd",
192+
"markdown_phpextra",
193+
"markdown_strict",
194+
"markua",
195+
"mediawiki",
196+
"ms",
197+
"muse",
198+
"native",
199+
"odt",
200+
"opendocument",
201+
"opml",
202+
"org",
203+
"pdf",
204+
"plain",
205+
"pptx",
206+
"revealjs",
207+
"rst",
208+
"rtf",
209+
"s5",
210+
"slideous",
211+
"slidy",
212+
"tei",
213+
"texinfo",
214+
"textile",
215+
"typst",
216+
"xwiki",
217+
"zimwiki",
218+
"md",
219+
"dashboard"
220+
]
221+
},
150222
{
151223
"name": "tags",
152224
"description": "Array of tags for notebook cell",
@@ -301,7 +373,7 @@
301373
"options": [
302374
{
303375
"name": "eval",
304-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n",
376+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n",
305377
"formats": [
306378
"asciidoc",
307379
"asciidoctor",

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

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,78 @@
146146
"md",
147147
"dashboard"
148148
]
149+
},
150+
{
151+
"name": "renderings",
152+
"description": "Array of rendering names, e.g. `[light, dark]`",
153+
"formats": [
154+
"asciidoc",
155+
"asciidoctor",
156+
"beamer",
157+
"biblatex",
158+
"bibtex",
159+
"chunkedhtml",
160+
"commonmark",
161+
"commonmark_x",
162+
"context",
163+
"csljson",
164+
"docbook",
165+
"docbook4",
166+
"docbook5",
167+
"docx",
168+
"dokuwiki",
169+
"dzslides",
170+
"epub",
171+
"epub2",
172+
"epub3",
173+
"fb2",
174+
"gfm",
175+
"haddock",
176+
"html",
177+
"html4",
178+
"html5",
179+
"icml",
180+
"ipynb",
181+
"jats",
182+
"jats_archiving",
183+
"jats_articleauthoring",
184+
"jats_publishing",
185+
"jira",
186+
"json",
187+
"latex",
188+
"man",
189+
"markdown",
190+
"markdown_github",
191+
"markdown_mmd",
192+
"markdown_phpextra",
193+
"markdown_strict",
194+
"markua",
195+
"mediawiki",
196+
"ms",
197+
"muse",
198+
"native",
199+
"odt",
200+
"opendocument",
201+
"opml",
202+
"org",
203+
"pdf",
204+
"plain",
205+
"pptx",
206+
"revealjs",
207+
"rst",
208+
"rtf",
209+
"s5",
210+
"slideous",
211+
"slidy",
212+
"tei",
213+
"texinfo",
214+
"textile",
215+
"typst",
216+
"xwiki",
217+
"zimwiki",
218+
"md",
219+
"dashboard"
220+
]
149221
}
150222
]
151223
},
@@ -155,7 +227,7 @@
155227
"options": [
156228
{
157229
"name": "eval",
158-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n",
230+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n",
159231
"formats": [
160232
"asciidoc",
161233
"asciidoctor",

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

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,78 @@
146146
"md",
147147
"dashboard"
148148
]
149+
},
150+
{
151+
"name": "renderings",
152+
"description": "Array of rendering names, e.g. `[light, dark]`",
153+
"formats": [
154+
"asciidoc",
155+
"asciidoctor",
156+
"beamer",
157+
"biblatex",
158+
"bibtex",
159+
"chunkedhtml",
160+
"commonmark",
161+
"commonmark_x",
162+
"context",
163+
"csljson",
164+
"docbook",
165+
"docbook4",
166+
"docbook5",
167+
"docx",
168+
"dokuwiki",
169+
"dzslides",
170+
"epub",
171+
"epub2",
172+
"epub3",
173+
"fb2",
174+
"gfm",
175+
"haddock",
176+
"html",
177+
"html4",
178+
"html5",
179+
"icml",
180+
"ipynb",
181+
"jats",
182+
"jats_archiving",
183+
"jats_articleauthoring",
184+
"jats_publishing",
185+
"jira",
186+
"json",
187+
"latex",
188+
"man",
189+
"markdown",
190+
"markdown_github",
191+
"markdown_mmd",
192+
"markdown_phpextra",
193+
"markdown_strict",
194+
"markua",
195+
"mediawiki",
196+
"ms",
197+
"muse",
198+
"native",
199+
"odt",
200+
"opendocument",
201+
"opml",
202+
"org",
203+
"pdf",
204+
"plain",
205+
"pptx",
206+
"revealjs",
207+
"rst",
208+
"rtf",
209+
"s5",
210+
"slideous",
211+
"slidy",
212+
"tei",
213+
"texinfo",
214+
"textile",
215+
"typst",
216+
"xwiki",
217+
"zimwiki",
218+
"md",
219+
"dashboard"
220+
]
149221
}
150222
]
151223
},
@@ -155,7 +227,7 @@
155227
"options": [
156228
{
157229
"name": "eval",
158-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n",
230+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n",
159231
"formats": [
160232
"asciidoc",
161233
"asciidoctor",

‎docs/reference/formats/asciidoc.json‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"options": [
3232
{
3333
"name": "brand",
34-
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
34+
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
3535
},
3636
{
3737
"name": "quarto-required",
@@ -61,10 +61,6 @@
6161
"name": "number-sections",
6262
"description": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n"
6363
},
64-
{
65-
"name": "number-offset",
66-
"description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
67-
},
6864
{
6965
"name": "shift-heading-level-by",
7066
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
@@ -98,7 +94,7 @@
9894
"options": [
9995
{
10096
"name": "eval",
101-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
97+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
10298
},
10399
{
104100
"name": "echo",

‎docs/reference/formats/context.json‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"options": [
3636
{
3737
"name": "brand",
38-
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
38+
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
3939
},
4040
{
4141
"name": "pdf-engine",
@@ -77,10 +77,6 @@
7777
"name": "number-sections",
7878
"description": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n"
7979
},
80-
{
81-
"name": "number-offset",
82-
"description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
83-
},
8480
{
8581
"name": "shift-heading-level-by",
8682
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
@@ -200,7 +196,7 @@
200196
"options": [
201197
{
202198
"name": "eval",
203-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
199+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
204200
},
205201
{
206202
"name": "echo",

‎docs/reference/formats/dashboard.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
"options": [
5858
{
5959
"name": "brand",
60-
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
60+
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
6161
},
6262
{
6363
"name": "theme",
@@ -220,7 +220,7 @@
220220
"options": [
221221
{
222222
"name": "eval",
223-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
223+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
224224
},
225225
{
226226
"name": "echo",

‎docs/reference/formats/docbook.json‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"options": [
2828
{
2929
"name": "brand",
30-
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
30+
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
3131
},
3232
{
3333
"name": "identifier-prefix",
@@ -47,10 +47,6 @@
4747
"name": "number-sections",
4848
"description": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n"
4949
},
50-
{
51-
"name": "number-offset",
52-
"description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
53-
},
5450
{
5551
"name": "shift-heading-level-by",
5652
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
@@ -88,7 +84,7 @@
8884
"options": [
8985
{
9086
"name": "eval",
91-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
87+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
9288
},
9389
{
9490
"name": "echo",

‎docs/reference/formats/docx.json‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
},
4444
{
4545
"name": "brand",
46-
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
46+
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
4747
},
4848
{
4949
"name": "quarto-required",
@@ -81,10 +81,6 @@
8181
"name": "number-depth",
8282
"description": "By default, all headings in your document create a \nnumbered section. You customize numbering depth using \nthe `number-depth` option. \n\nFor example, to only number sections immediately below \nthe chapter level, use this:\n\n```yaml \nnumber-depth: 1\n```\n"
8383
},
84-
{
85-
"name": "number-offset",
86-
"description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
87-
},
8884
{
8985
"name": "shift-heading-level-by",
9086
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
@@ -134,7 +130,7 @@
134130
"options": [
135131
{
136132
"name": "eval",
137-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
133+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
138134
},
139135
{
140136
"name": "echo",

0 commit comments

Comments
 (0)