Skip to content

Commit 383aa2a

Browse files
Improve include-after-body documentation (#4657)
* clarify documentation for `include-after-body` * build-js
1 parent 2f9e73d commit 383aa2a

File tree

5 files changed

+51
-48
lines changed

5 files changed

+51
-48
lines changed

src/resources/editor/tools/vs-code.mjs

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8531,12 +8531,13 @@ var require_yaml_intelligence_resources = __commonJS({
85318531
{
85328532
enum: [
85338533
"always",
8534+
"whenSidebarOpen",
85348535
"never"
85358536
]
85368537
}
85378538
],
85388539
default: "always",
8539-
description: "Controls whether the in-document highlights are shown by default (`always` or `never`)"
8540+
description: "Controls whether the in-document highlights are shown by default (`always`, `whenSidebarOpen` or `never`)"
85408541
},
85418542
theme: {
85428543
enum: [
@@ -13489,7 +13490,7 @@ var require_yaml_intelligence_resources = __commonJS({
1348913490
]
1349013491
}
1349113492
},
13492-
description: 'Include contents at the beginning of the document body\n(e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command \nin LaTeX).\n\nA string value or an object with key "file" indicates a filename whose contents are to be included\n\nAn object with key "text" indicates textual content to be included\n'
13493+
description: 'Include contents at the beginning of the document body\n(e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command\nin LaTeX).\n\nA string value or an object with key "file" indicates a filename whose contents are to be included\n\nAn object with key "text" indicates textual content to be included\n'
1349313494
},
1349413495
{
1349513496
name: "include-after-body",
@@ -13508,7 +13509,7 @@ var require_yaml_intelligence_resources = __commonJS({
1350813509
]
1350913510
}
1351013511
},
13511-
description: 'Include contents at the end of the document body (before\nthe `</body>` tag in HTML, or the `\\end{document}` command in LaTeX).\n\nA string value or an object with key "file" indicates a filename whose contents are to be included\n\nAn object with key "text" indicates textual content to be included\n'
13512+
description: 'Include content at the end of the document body immediately after the markdown content. While it will be included before the closing `</body>` tag in HTML and the `\\end{document}` command in LaTeX, this option refers to the end of the markdown content.\n\nA string value or an object with key "file" indicates a filename whose contents are to be included\n\nAn object with key "text" indicates textual content to be included\n'
1351213513
},
1351313514
{
1351413515
name: "include-in-header",
@@ -13527,7 +13528,7 @@ var require_yaml_intelligence_resources = __commonJS({
1352713528
]
1352813529
}
1352913530
},
13530-
description: 'Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML \ndocuments.\n\nA string value or an object with key "file" indicates a filename whose contents are to be included\n\nAn object with key "text" indicates textual content to be included\n'
13531+
description: 'Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML\ndocuments.\n\nA string value or an object with key "file" indicates a filename whose contents are to be included\n\nAn object with key "text" indicates textual content to be included\n'
1353113532
},
1353213533
{
1353313534
name: "resources",
@@ -13553,7 +13554,7 @@ var require_yaml_intelligence_resources = __commonJS({
1355313554
},
1355413555
description: {
1355513556
short: "Text to be in a running header.",
13556-
long: "Text to be in a running header.\n\nProvide a single option or up to four options for different placements \n(odd page inner, odd page outer, even page innner, even page outer).\n"
13557+
long: "Text to be in a running header.\n\nProvide a single option or up to four options for different placements\n(odd page inner, odd page outer, even page innner, even page outer).\n"
1355713558
}
1355813559
},
1355913560
{
@@ -13568,7 +13569,7 @@ var require_yaml_intelligence_resources = __commonJS({
1356813569
},
1356913570
description: {
1357013571
short: "Text to be in a running footer.",
13571-
long: "Text to be in a running footer.\n\nProvide a single option or up to four options for different placements \n(odd page inner, odd page outer, even page innner, even page outer).\n\nSee [ConTeXt Headers and Footers](https://wiki.contextgarden.net/Headers_and_Footers) for more information.\n"
13572+
long: "Text to be in a running footer.\n\nProvide a single option or up to four options for different placements\n(odd page inner, odd page outer, even page innner, even page outer).\n\nSee [ConTeXt Headers and Footers](https://wiki.contextgarden.net/Headers_and_Footers) for more information.\n"
1357213573
}
1357313574
},
1357413575
{
@@ -13608,7 +13609,7 @@ var require_yaml_intelligence_resources = __commonJS({
1360813609
hidden: true,
1360913610
description: {
1361013611
short: "Include file with YAML metadata",
13611-
long: "Read metadata from the supplied YAML (or JSON) file. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nMetadata values specified inside the document, or by using `-M`, \noverwrite values specified with this option.\n"
13612+
long: "Read metadata from the supplied YAML (or JSON) file. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nMetadata values specified inside the document, or by using `-M`,\noverwrite values specified with this option.\n"
1361213613
}
1361313614
},
1361413615
{
@@ -13618,7 +13619,7 @@ var require_yaml_intelligence_resources = __commonJS({
1361813619
},
1361913620
description: {
1362013621
short: "Include files with YAML metadata",
13621-
long: "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside \nthe document, or by using `-M`, overwrite values specified with\nthis option.\n"
13622+
long: "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside\nthe document, or by using `-M`, overwrite values specified with\nthis option.\n"
1362213623
}
1362313624
}
1362413625
],
@@ -18232,7 +18233,7 @@ var require_yaml_intelligence_resources = __commonJS({
1823218233
"The giscus theme to use when displaying comments.",
1823318234
"The language that should be used when displaying the commenting\ninterface.",
1823418235
"Controls whether the sidebar opens automatically on startup.",
18235-
"Controls whether the in-document highlights are shown by default\n(<code>always</code> or <code>never</code>)",
18236+
"Controls whether the in-document highlights are shown by default\n(<code>always</code>, <code>whenSidebarOpen</code> or\n<code>never</code>)",
1823618237
"Controls the overall look of the sidebar (<code>classic</code> or\n<code>clean</code>)",
1823718238
"Controls whether the experimental New Note button should be shown in\nthe notes tab in the sidebar.",
1823818239
"Specify a URL to direct a user to, in a new tab. when they click on\nthe annotation author link in the header of an annotation.",
@@ -19843,7 +19844,7 @@ var require_yaml_intelligence_resources = __commonJS({
1984319844
"Content to include at the beginning of the document body (e.g.&nbsp;after\nthe <code>&lt;body&gt;</code> tag in HTML, or the\n<code>\\begin{document}</code> command in LaTeX).",
1984419845
"Content to include at the end of the document body (before the\n<code>&lt;/body&gt;</code> tag in HTML, or the\n<code>\\end{document}</code> command in LaTeX).",
1984519846
"Include contents at the beginning of the document body (e.g.&nbsp;after\nthe <code>&lt;body&gt;</code> tag in HTML, or the\n<code>\\begin{document}</code> command in LaTeX).\nA string value or an object with key \u201Cfile\u201D indicates a filename\nwhose contents are to be included\nAn object with key \u201Ctext\u201D indicates textual content to be\nincluded",
19846-
"Include contents at the end of the document body (before the\n<code>&lt;/body&gt;</code> tag in HTML, or the\n<code>\\end{document}</code> command in LaTeX).\nA string value or an object with key \u201Cfile\u201D indicates a filename\nwhose contents are to be included\nAn object with key \u201Ctext\u201D indicates textual content to be\nincluded",
19847+
"Include content at the end of the document body, immediately after\nthe markdown content. While the content will be included before the\nclosing <code>&lt;/body&gt;</code> tag in HTML and the\n<code>\\end{document}</code> command in LaTeX, this option specifically\nrefers to the end of the content.\nA string value or an object with key \u201Cfile\u201D indicates a filename\nwhose contents are to be included\nAn object with key \u201Ctext\u201D indicates textual content to be\nincluded",
1984719848
"Include contents at the end of the header. This can be used, for\nexample, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key \u201Cfile\u201D indicates a filename\nwhose contents are to be included\nAn object with key \u201Ctext\u201D indicates textual content to be\nincluded",
1984819849
"Path (or glob) to files to publish with this document.",
1984919850
{
@@ -21233,12 +21234,12 @@ var require_yaml_intelligence_resources = __commonJS({
2123321234
mermaid: "%%"
2123421235
},
2123521236
"handlers/mermaid/schema.yml": {
21236-
_internalId: 151733,
21237+
_internalId: 151732,
2123721238
type: "object",
2123821239
description: "be an object",
2123921240
properties: {
2124021241
"mermaid-format": {
21241-
_internalId: 151725,
21242+
_internalId: 151724,
2124221243
type: "enum",
2124321244
enum: [
2124421245
"png",
@@ -21254,7 +21255,7 @@ var require_yaml_intelligence_resources = __commonJS({
2125421255
exhaustiveCompletions: true
2125521256
},
2125621257
theme: {
21257-
_internalId: 151732,
21258+
_internalId: 151731,
2125821259
type: "anyOf",
2125921260
anyOf: [
2126021261
{

0 commit comments

Comments
 (0)