-
Notifications
You must be signed in to change notification settings - Fork 320
/
format-html.ts
1055 lines (951 loc) · 30.5 KB
/
format-html.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// noinspection TypeScriptUnresolvedReference
/*
* format-html.ts
*
* Copyright (C) 2020-2022 Posit Software, PBC
*/
import { join } from "../../deno_ral/path.ts";
import { warning } from "../../deno_ral/log.ts";
import * as ld from "../../core/lodash.ts";
import { Document, Element } from "../../core/deno-dom.ts";
import { renderEjs } from "../../core/ejs.ts";
import { mergeConfigs } from "../../core/config.ts";
import { formatResourcePath } from "../../core/resources.ts";
import { TempContext } from "../../core/temp.ts";
import { asCssSize } from "../../core/css.ts";
import {
kBodyClasses,
kCodeLink,
kFigResponsive,
kFilterParams,
kHeaderIncludes,
kIncludeAfterBody,
kIncludeInHeader,
kLinkExternalFilter,
kLinkExternalIcon,
kLinkExternalNewwindow,
kNotebookLinks,
kNotebookViewStyle,
kTheme,
} from "../../config/constants.ts";
import {
DependencyHtmlFile,
Format,
FormatDependency,
FormatExtras,
kDependencies,
kHtmlPostprocessors,
kSassBundles,
Metadata,
PandocFlags,
SassBundle,
} from "../../config/types.ts";
import {
formatHasCodeTools,
kEmbeddedSourceModalId,
} from "../../command/render/codetools.ts";
import { createHtmlFormat } from "./../formats-shared.ts";
import {
darkModeDefault,
formatDarkMode,
formatHasBootstrap,
} from "./format-html-info.ts";
import { bootstrapExtras } from "./format-html-bootstrap.ts";
import {
clipboardDependency,
createCodeCopyButton,
kAnchorSections,
kBootstrapDependencyName,
kCitationsHover,
kCodeAnnotations,
kCodeCopy,
kComments,
kDocumentCss,
kFootnotesHover,
kGiscus,
kGiscusCategoryId,
kGiscusRepoId,
kHypothesis,
kMinimal,
kSmoothScroll,
kTabsets,
kUtterances,
kXrefsHover,
quartoBaseLayer,
quartoGlobalCssVariableRules,
} from "./format-html-shared.ts";
import {
kSiteUrl,
kWebsite,
} from "../../project/types/website/website-constants.ts";
import {
HtmlPostProcessResult,
RenderServices,
} from "../../command/render/types.ts";
import {
buildGiscusThemeKeys,
getDiscussionCategoryId,
getGithubDiscussionsMetadata,
GiscusTheme,
GiscusThemeToggleRecord,
} from "../../core/giscus.ts";
import { metadataPostProcessor } from "./format-html-meta.ts";
import { kHtmlEmptyPostProcessResult } from "../../command/render/constants.ts";
import { kNotebookViewStyleNotebook } from "./format-html-constants.ts";
import { notebookViewPostProcessor } from "./format-html-notebook.ts";
import { ProjectContext } from "../../project/types.ts";
import { kListing } from "../../project/types/website/listing/website-listing-shared.ts";
import {
HtmlFormatFeatureDefaults,
HtmlFormatScssOptions,
HtmlFormatTippyOptions,
} from "./format-html-types.ts";
import { kQuartoHtmlDependency } from "./format-html-constants.ts";
import { registerWriterFormatHandler } from "../format-handlers.ts";
export function htmlFormat(
figwidth: number,
figheight: number,
): Format {
return mergeConfigs(
createHtmlFormat("HTML", figwidth, figheight),
{
render: {
[kNotebookLinks]: true,
},
resolveFormat: (format: Format) => {
if (format.metadata[kMinimal] === true) {
if (format.metadata[kFigResponsive] === undefined) {
format.metadata[kFigResponsive] = false;
}
if (format.metadata[kTheme] === undefined) {
format.metadata[kTheme] = "none";
}
}
},
formatExtras: async (
input: string,
_markdown: string,
flags: PandocFlags,
format: Format,
_libDir: string,
services: RenderServices,
offset: string,
project: ProjectContext,
quiet?: boolean,
) => {
// Warn the user if they are using a listing outside of a website
if (!project && format.metadata[kListing]) {
warning(
`Quarto only supports listings within websites. Please ensure that the file ${input} is a part of a website project to enable listing rendering.`,
);
}
const htmlFilterParams = htmlFormatFilterParams(format);
return mergeConfigs(
await htmlFormatExtras(
input,
flags,
offset,
format,
services.temp,
project,
),
themeFormatExtras(
input,
flags,
format,
services,
offset,
project,
quiet,
),
{ [kFilterParams]: htmlFilterParams },
);
},
extensions: {
book: {
multiFile: true,
},
},
},
);
}
export async function htmlFormatExtras(
input: string,
_flags: PandocFlags,
offset: string,
format: Format,
temp: TempContext,
_project?: ProjectContext,
featureDefaults?: HtmlFormatFeatureDefaults,
tippyOptions?: HtmlFormatTippyOptions,
scssOptions?: HtmlFormatScssOptions,
): Promise<FormatExtras> {
// note whether we are targeting bootstrap
const bootstrap = formatHasBootstrap(format);
// populate feature defaults if none provided
if (!featureDefaults) {
featureDefaults = htmlFormatFeatureDefaults(format);
}
// empty tippy options if none provided
if (!tippyOptions) {
tippyOptions = {};
}
if (!tippyOptions.config) {
tippyOptions.config = {};
}
if (!scssOptions) {
scssOptions = {};
}
if (scssOptions.quartoBase === undefined) {
scssOptions.quartoBase = true;
}
if (scssOptions.quartoCssVars === undefined) {
scssOptions.quartoCssVars = true;
}
// lists of scripts and ejs data for the orchestration script
const scripts: DependencyHtmlFile[] = [];
const stylesheets: DependencyHtmlFile[] = [];
const sassBundles: SassBundle[] = [];
const dependencies: FormatDependency[] = [];
const options: Record<string, unknown> =
ld.isObject(format.metadata[kComments])
? {
[kHypothesis]: (format.metadata[kComments] as Record<string, unknown>)[
kHypothesis
] ||
false,
[kUtterances]: (format.metadata[kComments] as Record<string, unknown>)[
kUtterances
] ||
false,
[kGiscus]:
(format.metadata[kComments] as Record<string, unknown>)[kGiscus] ||
false,
}
: {};
options.codeLink = format.metadata[kCodeLink] || false;
// apply defaults
if (featureDefaults.tabby) {
options.tabby = format.metadata[kTabsets] !== false;
} else {
options.tabby = format.metadata[kTabsets] || false;
}
if (featureDefaults.copyCode) {
options.copyCode = format.metadata[kCodeCopy] !== false;
} else {
options.copyCode = format.metadata[kCodeCopy] || false;
}
if (featureDefaults.anchors) {
options.anchors = format.metadata[kAnchorSections] !== false;
} else {
options.anchors = format.metadata[kAnchorSections] || false;
}
if (featureDefaults.hoverCitations) {
options.hoverCitations = format.metadata[kCitationsHover] !== false;
} else {
options.hoverCitations = format.metadata[kCitationsHover] || false;
}
if (featureDefaults.hoverFootnotes) {
options.hoverFootnotes = format.metadata[kFootnotesHover] !== false;
} else {
options.hoverFootnotes = format.metadata[kFootnotesHover] || false;
}
// Books don't currently support hover xrefs (since the content to preview in the xref
// is likely to be on another page and we don't want to do a full fetch of that page
// to get the preview)
if (featureDefaults.hoverXrefs) {
options.hoverXrefs = format.metadata[kXrefsHover] !== false;
} else {
options.hoverXrefs = format.metadata[kXrefsHover] || false;
}
if (featureDefaults.figResponsive) {
options.figResponsive = format.metadata[kFigResponsive] !== false;
} else {
options.figResponsive = format.metadata[kFigResponsive] || false;
}
if (featureDefaults.codeAnnotations) {
options.codeAnnotations = format.metadata[kCodeAnnotations] || true;
} else {
options.codeAnnotations = format.metadata[kCodeAnnotations] || false;
}
options.zenscroll = format.metadata[kSmoothScroll];
options.codeTools = formatHasCodeTools(format);
options.darkMode = formatDarkMode(format);
options.darkModeDefault = darkModeDefault(format.metadata);
options.linkExternalIcon = format.render[kLinkExternalIcon];
options.linkExternalNewwindow = format.render[kLinkExternalNewwindow];
options.linkExternalFilter = format.render[kLinkExternalFilter];
// If there is a site URL, we can use that as the default filter
const siteMetadata = format.metadata[kWebsite] as Metadata;
if (!options.linkExternalFilter && siteMetadata) {
const siteUrl = siteMetadata[kSiteUrl] as string;
if (siteUrl) {
options.linkExternalFilter = siteUrl.replaceAll(".", "\\.").replaceAll(
"/",
"\\/",
);
}
}
// quarto.js helpers
if (bootstrap) {
scripts.push({
name: "quarto.js",
path: formatResourcePath("html", "quarto.js"),
});
}
// tabby if required
if (options.tabby) {
scripts.push({
name: "tabby.min.js",
path: formatResourcePath("html", join("tabby", "js", "tabby.js")),
});
}
// header includes
const includeInHeader: string[] = [];
// zenscroll if required
if (options.zenscroll) {
scripts.push({
name: "zenscroll-min.js",
path: formatResourcePath("html", join("zenscroll", "zenscroll-min.js")),
afterBody: true,
});
const zenscrollStyle = temp.createFile({ suffix: "-zen.html" });
Deno.writeTextFileSync(
zenscrollStyle,
"<style>html{ scroll-behavior: smooth; }</style>",
);
includeInHeader.push(zenscrollStyle);
}
// popper if required
options.tippy = options.hoverCitations || options.hoverFootnotes ||
options.codeAnnotations || options.hoverXrefs;
if (bootstrap || options.tippy) {
scripts.push({
name: "popper.min.js",
path: formatResourcePath("html", join("popper", "popper.min.js")),
});
}
// tippy if required
if (options.tippy) {
scripts.push({
name: "tippy.umd.min.js",
path: formatResourcePath("html", join("tippy", "tippy.umd.min.js")),
});
stylesheets.push({
name: "tippy.css",
path: formatResourcePath("html", join("tippy", "tippy.css")),
});
// If this is a bootstrap format, include requires sass
if (tippyOptions.theme === undefined) {
if (bootstrap) {
tippyOptions.theme = "quarto";
sassBundles.push({
key: "tippy.scss",
dependency: kBootstrapDependencyName,
quarto: {
uses: "",
functions: "",
defaults: "",
mixins: "",
rules: Deno.readTextFileSync(
formatResourcePath("html", join("tippy", "_tippy.scss")),
),
},
});
} else {
tippyOptions.theme = "light-border";
stylesheets.push({
name: "light-border.css",
path: formatResourcePath("html", join("tippy", "light-border.css")),
});
}
}
}
// propagate tippyOptions
options.tippyOptions = tippyOptions;
// clipboard.js if required
if (options.copyCode) {
dependencies.push(clipboardDependency());
}
// Add localization strings
options.language = format.language;
// anchors if required
if (options.anchors) {
scripts.push({
name: "anchor.min.js",
path: formatResourcePath("html", join("anchor", "anchor.min.js")),
});
options.anchors = typeof (options.anchors) === "string"
? options.anchors
: true;
}
// add quarto sass bundle of we aren't in bootstrap
const minimal = format.metadata[kMinimal] === true;
if (!bootstrap && !minimal) {
if (scssOptions.quartoBase) {
sassBundles.push({
dependency: kQuartoHtmlDependency,
key: kQuartoHtmlDependency,
quarto: quartoBaseLayer(
format,
!!options.copyCode,
!!options.tabby,
!!options.figResponsive,
),
});
}
if (scssOptions.quartoCssVars) {
sassBundles.push({
dependency: kQuartoHtmlDependency,
key: kQuartoHtmlDependency,
quarto: {
uses: "",
defaults: "",
functions: "",
mixins: "",
rules: quartoGlobalCssVariableRules(),
},
});
}
}
// hypothesis
if (options.hypothesis) {
const hypothesisHeader = temp.createFile({ suffix: "-hypoth.html" });
Deno.writeTextFileSync(
hypothesisHeader,
renderEjs(
formatResourcePath("html", join("hypothesis", "hypothesis.ejs")),
{ hypothesis: options.hypothesis },
),
);
includeInHeader.push(hypothesisHeader);
}
// after body
const includeAfterBody: string[] = [];
// add main orchestion script if we have any options enabled
const quartoHtmlRequired = Object.keys(options).some((option) =>
!!options[option]
);
if (quartoHtmlRequired) {
// html orchestration script
const quartoHtmlScript = temp.createFile();
const renderedHtml = renderEjs(
formatResourcePath("html", join("templates", "quarto-html.ejs")),
options,
);
if (renderedHtml.trim() !== "") {
Deno.writeTextFileSync(quartoHtmlScript, renderedHtml);
includeAfterBody.push(quartoHtmlScript);
}
}
// utterances
if (options.utterances) {
if (typeof (options.utterances) !== "object") {
throw new Error("Invalid utterances configuration (must provide a repo");
}
const utterances = options.utterances as Record<string, string>;
if (!utterances["repo"]) {
throw new Error("Invalid utterances coniguration (must provide a repo)");
}
utterances["issue-term"] = utterances["issue-term"] || "pathname";
utterances["theme"] = utterances["theme"] || "github-light";
const utterancesAfterBody = temp.createFile({ suffix: "-utter.html" });
Deno.writeTextFileSync(
utterancesAfterBody,
renderEjs(
formatResourcePath("html", join("utterances", "utterances.ejs")),
{ utterances },
),
);
includeAfterBody.push(utterancesAfterBody);
}
// giscus
if (options.giscus) {
const giscus = options.giscus as Record<string, unknown>;
giscus.category = giscus.category || "General";
giscus.theme = giscus.theme || "";
const themeToggleRecord: GiscusThemeToggleRecord = buildGiscusThemeKeys(
Boolean(options.darkModeDefault),
giscus.theme as GiscusTheme,
);
giscus.baseTheme = themeToggleRecord.baseTheme;
giscus.altTheme = themeToggleRecord.altTheme;
giscus.theme = giscus.baseTheme;
giscus.mapping = giscus.mapping || "title";
giscus["reactions-enabled"] = giscus["reactions-enabled"] !== undefined
? giscus["reactions-enabled"]
: true;
giscus["input-position"] = giscus["input-position"] || "top";
giscus.language = giscus.language || "en";
if (
giscus[kGiscusRepoId] === undefined ||
giscus[kGiscusCategoryId] === undefined
) {
const discussionData = await getGithubDiscussionsMetadata(
giscus.repo as string,
);
// Fetch repo info
if (giscus[kGiscusRepoId] === undefined && discussionData.repositoryId) {
giscus[kGiscusRepoId] = discussionData.repositoryId;
}
const categoryId = getDiscussionCategoryId(
giscus.category as string,
discussionData,
);
if (giscus[kGiscusCategoryId] === undefined && categoryId) {
giscus[kGiscusCategoryId] = categoryId;
}
}
const giscusAfterBody = temp.createFile({ suffix: "-giscus.html" });
Deno.writeTextFileSync(
giscusAfterBody,
renderEjs(
formatResourcePath("html", join("giscus", "giscus.ejs")),
{ giscus },
),
);
includeAfterBody.push(giscusAfterBody);
}
// return extras
dependencies.push({
name: kQuartoHtmlDependency,
scripts,
stylesheets,
});
// Provide a template and partials
const templateDir = formatResourcePath("html", "pandoc");
const partials = [
"metadata.html",
"title-block.html",
"toc.html",
"styles.html",
];
const templateContext = {
template: join(templateDir, "template.html"),
partials: partials.map((partial) => join(templateDir, partial)),
};
const htmlPostProcessors = [
htmlFormatPostprocessor(format, featureDefaults),
metadataPostProcessor(input, format, offset),
];
const viewStyle = format.render[kNotebookViewStyle];
if (viewStyle === kNotebookViewStyleNotebook) {
htmlPostProcessors.push(notebookViewPostProcessor());
}
const metadata: Metadata = {};
return {
[kIncludeInHeader]: includeInHeader,
[kIncludeAfterBody]: includeAfterBody,
metadata,
templateContext,
html: {
[kDependencies]: dependencies,
[kSassBundles]: sassBundles,
[kHtmlPostprocessors]: htmlPostProcessors,
},
};
}
const kFormatHasBootstrap = "has-bootstrap";
function htmlFormatFilterParams(format: Format) {
return {
[kFormatHasBootstrap]: formatHasBootstrap(format),
};
}
function htmlFormatFeatureDefaults(
format: Format,
): HtmlFormatFeatureDefaults {
const bootstrap = formatHasBootstrap(format);
const minimal = format.metadata[kMinimal] === true;
return {
tabby: !minimal && !bootstrap,
copyCode: !minimal,
anchors: !minimal,
hoverCitations: !minimal,
hoverFootnotes: !minimal,
figResponsive: !minimal,
codeAnnotations: !minimal,
hoverXrefs: !minimal,
};
}
function htmlFormatPostprocessor(
format: Format,
featureDefaults?: HtmlFormatFeatureDefaults,
) {
// do we have haveBootstrap
const haveBootstrap = formatHasBootstrap(format);
// get feature defaults
if (!featureDefaults) {
featureDefaults = htmlFormatFeatureDefaults(format);
}
// read options
const codeCopy = featureDefaults.copyCode
? format.metadata[kCodeCopy] !== false
: format.metadata[kCodeCopy] || false;
const anchors = featureDefaults.anchors
? format.metadata[kAnchorSections] !== false
: format.metadata[kAnchorSections] || false;
return (doc: Document): Promise<HtmlPostProcessResult> => {
// Add body class, if present
if (format.render[kBodyClasses]) {
const clz = format.render[kBodyClasses].split(" ");
clz.forEach((cls) => {
doc.body.classList.add(cls);
});
}
// process all of the code blocks
const codeBlocks = doc.querySelectorAll("pre.sourceCode");
const EmbedSourceModal = doc.querySelector(
`#${kEmbeddedSourceModalId}`,
);
for (let i = 0; i < codeBlocks.length; i++) {
const code = codeBlocks[i] as Element;
// hoist hidden and cell-code to parent div
const parentHoist = (clz: string) => {
if (code.classList.contains(clz)) {
code.classList.remove(clz);
code.parentElement?.classList.add(clz);
}
};
parentHoist("cell-code");
parentHoist("hidden");
// hoist hidden to parent div
if (code.classList.contains("hidden")) {
code.classList.remove("hidden");
code.parentElement?.classList.add("hidden");
}
// insert code copy button (with specfic attribute when inside a modal)
if (codeCopy) {
code.classList.add("code-with-copy");
const copyButton = createCodeCopyButton(doc, format);
if (EmbedSourceModal && EmbedSourceModal.contains(code)) {
copyButton.setAttribute("data-in-quarto-modal", "");
}
code.appendChild(copyButton);
}
// insert example iframe
if (code.parentElement?.getAttribute("data-code-preview")) {
const codeExample = doc.createElement("iframe");
for (const parentClass of code.classList) {
codeExample.classList.add(parentClass);
}
codeExample.setAttribute(
"src",
code.parentElement.getAttribute("data-code-preview")!.replace(
/\.qmd$/,
".html",
),
);
code.parentElement.removeAttribute(
"data-code-preview",
);
code.parentElement.appendChild(codeExample);
}
}
// add .anchored class to headings
if (anchors) {
const container = haveBootstrap
? doc.querySelector("main")
: doc.querySelector("body");
if (container) {
["h2", "h3", "h4", "h5", "h6", ".quarto-figure[id]", "div[id^=tbl-]"]
.forEach(
(selector) => {
const headings = container.querySelectorAll(selector);
for (let i = 0; i < headings.length; i++) {
const heading = headings[i] as Element;
if (heading.id !== "toc-title") {
if (!heading.classList.contains("no-anchor")) {
heading.classList.add("anchored");
}
}
}
},
);
}
}
// remove toc-section-number if we have provided our own section numbers
const headerSections = doc.querySelectorAll(".header-section-number");
for (let i = 0; i < headerSections.length; i++) {
const secNumber = headerSections[i] as Element;
const prevElement = secNumber.previousElementSibling;
if (prevElement && prevElement.classList.contains("toc-section-number")) {
secNumber.remove();
}
}
// Process code annotations that may appear in this document
processCodeAnnotations(format, doc);
// Process tables to restore th-vs-td markers
const tables = doc.querySelectorAll(
'table[data-quarto-postprocess-tables="true"]',
);
for (let i = 0; i < tables.length; ++i) {
const table = tables[i] as Element;
if (table.getAttribute("data-quarto-disable-processing")) {
continue;
}
table.removeAttribute("data-quarto-postprocess-tables");
table.querySelectorAll("tr").forEach((tr) => {
const { children } = tr as Element;
for (let j = 0; j < children.length; ++j) {
const child = children[j] as Element;
if (child.tagName === "TH" || child.tagName === "TD") {
const isTH =
child.getAttribute("data-quarto-table-cell-role") === "th";
// create a new element with the correct tag and move all children and attributes to
// new element
const newElement = doc.createElement(isTH ? "th" : "td");
while (child.firstChild) {
newElement.appendChild(child.firstChild);
}
for (let k = 0; k < child.attributes.length; ++k) {
const attr = child.attributes[k];
newElement.setAttribute(attr.name, attr.value);
}
// replace the old element with the new one
child.parentNode?.replaceChild(newElement, child);
}
}
});
}
// Process drafts, if needed
const metadraftEl = doc.querySelector("meta[name='quarto:status']");
if (metadraftEl !== null) {
const status = metadraftEl.getAttribute("content");
if (status === "draft") {
const draftDivEl = doc.createElement("DIV");
const iconEl = doc.createElement("I");
iconEl.classList.add("bi");
iconEl.classList.add("bi-pencil-square");
const textNode = doc.createTextNode(format.language.draft || "Draft");
draftDivEl.appendChild(iconEl);
draftDivEl.appendChild(textNode);
draftDivEl.setAttribute("id", "quarto-draft-alert");
draftDivEl.classList.add("alert");
draftDivEl.classList.add("alert-warning");
// Find the header and place it there
let targetEl = doc.body;
const headerEl = doc.getElementById("quarto-header");
if (headerEl !== null) {
targetEl = headerEl;
}
targetEl.insertBefore(draftDivEl, targetEl.firstChild);
}
}
// no resource refs
return Promise.resolve(kHtmlEmptyPostProcessResult);
};
}
const kCodeCellAttr = "data-code-cell";
const kCodeLinesAttr = "data-code-lines";
const kCodeAnnotationAttr = "data-code-annotation";
const kCodeCellTargetAttr = "data-target-cell";
const kCodeAnnotationTargetAttr = "data-target-annotation";
const kCodeAnnotationHiddenClz = "code-annotation-container-hidden";
const kCodeAnnotationGridClz = "code-annotation-container-grid";
const kCodeAnnotationAnchorClz = "code-annotation-anchor";
const kCodeAnnotationTargetClz = "code-annotation-target";
const kCodeAnnotationParentClz = "code-annotated";
const kCodeAnnotationGutterClz = "code-annotation-gutter";
const kCodeAnnotationGutterBgClz = "code-annotation-gutter-bg";
function processCodeAnnotations(format: Format, doc: Document) {
const annotationStyle: boolean | string = format.metadata[kCodeAnnotations] as
| string
| boolean;
const replaceLineNumberWithAnnote = (annoteEl: Element, dtEl: Element) => {
const annotation = annoteEl.getAttribute(kCodeAnnotationAttr);
if (annotation !== null) {
const ddEl = dtEl.previousElementSibling;
if (ddEl) {
ddEl.innerHTML = "";
ddEl.innerText = annotation;
const codeCell = annoteEl.getAttribute(kCodeCellAttr);
if (codeCell) {
ddEl.setAttribute(kCodeCellTargetAttr, codeCell);
ddEl.setAttribute(kCodeAnnotationTargetAttr, annotation);
}
}
}
};
if (annotationStyle === false) {
// Read the definition list values which contain the annotations
const annoteNodes = doc.querySelectorAll(`span[${kCodeCellAttr}]`);
// annotations are disabled, just hide the DL container
for (const annoteNode of annoteNodes) {
const annoteEl = annoteNode as Element;
// Mark the parent DL container with a class
// so CSS can target it
const parentDL = annoteEl.parentElement?.parentElement;
if (
parentDL && !parentDL.classList.contains(kCodeAnnotationHiddenClz)
) {
parentDL.classList.add(kCodeAnnotationHiddenClz);
}
}
} else if (annotationStyle === "hover" || annotationStyle === "select") {
const definitionLists = processCodeBlockAnnotation(
doc,
true,
"start",
replaceLineNumberWithAnnote,
);
Object.values(definitionLists).forEach((dl) => {
dl.classList.add(kCodeAnnotationHiddenClz);
dl.classList.add(kCodeAnnotationGridClz);
});
} else {
const definitionLists = processCodeBlockAnnotation(
doc,
false,
"start",
replaceLineNumberWithAnnote,
);
Object.values(definitionLists).forEach((dl) => {
dl.classList.add(kCodeAnnotationGridClz);
});
}
}
// returns DLs that were processed
function processCodeBlockAnnotation(
doc: Document,
interactiveAnnotations: boolean,
annotationPosition: "start" | "middle",
processDt?: (annotationEl: Element, dtEl: Element) => void,
) {
const definitionLists: Record<string, Element> = {};
const codeBlockParents: Element[] = [];
// Read the definition list values which contain the annotations
const annoteNodes = doc.querySelectorAll(`span[${kCodeCellAttr}]`);
for (const annoteNode of annoteNodes) {
const annoteEl = annoteNode as Element;
// Accumulate the Code Blocks
const parentCodeBlock = processLineAnnotation(
doc,
annoteEl,
interactiveAnnotations,
annotationPosition,
);
if (parentCodeBlock && !codeBlockParents.includes(parentCodeBlock)) {
codeBlockParents.push(parentCodeBlock);
}
// Accumulate the Definition Lists
const parentDL = annoteEl.parentElement?.parentElement;
const codeParentDivId = parentCodeBlock?.parentElement?.parentElement?.id;
if (
parentDL && codeParentDivId &&
!Object.keys(definitionLists).includes(codeParentDivId)
) {
definitionLists[codeParentDivId] = parentDL;
}
if (annoteEl.parentElement && processDt) {
processDt(annoteEl, annoteEl.parentElement);
}
}
// Inject a gutter for the annotations
for (const codeParentEl of codeBlockParents) {
if (codeParentEl.parentElement) {
// Decorate the pre so that we can adjust styles if needed
codeParentEl.parentElement.classList.add(kCodeAnnotationParentClz);
}
const gutterBgDivEl = doc.createElement("div");
gutterBgDivEl.classList.add(kCodeAnnotationGutterBgClz);
codeParentEl?.appendChild(gutterBgDivEl);
const gutterDivEl = doc.createElement("div");
gutterDivEl.classList.add(kCodeAnnotationGutterClz);
codeParentEl?.appendChild(gutterDivEl);
}
return definitionLists;
}
function processLineAnnotation(
doc: Document,
annoteEl: Element,
interactive: boolean,
position: "start" | "middle",
) {
// Read the target values from the annotation DL
const targetCell = annoteEl.getAttribute(kCodeCellAttr);
const targetLines = annoteEl.getAttribute(kCodeLinesAttr);
const targetAnnotation = annoteEl.getAttribute(kCodeAnnotationAttr);
if (targetCell && targetLines) {
const lineArr = targetLines?.split(",");
const targetIndex = position === "start"
? 0
: Math.floor(lineArr.length / 2);
const line = lineArr[targetIndex];
const targetId = `${targetCell}-${line}`;
const targetEl = doc.getElementById(targetId);
if (targetEl) {
const annoteAnchorEl = doc.createElement(interactive ? "button" : "a");
annoteAnchorEl.classList.add(kCodeAnnotationAnchorClz);
annoteAnchorEl.setAttribute(
kCodeCellTargetAttr,
`${targetCell}`,
);
annoteAnchorEl.setAttribute(
kCodeAnnotationTargetAttr,
`${targetAnnotation}`,
);
if (!interactive) {
annoteAnchorEl.setAttribute("onclick", "event.preventDefault();");
}
annoteAnchorEl.innerText = targetAnnotation || "?";
targetEl.parentElement?.insertBefore(annoteAnchorEl, targetEl);
targetEl.classList.add(kCodeAnnotationTargetClz);
return targetEl.parentElement;
}
}
}
function themeFormatExtras(
input: string,
flags: PandocFlags,