adocers-html 0.3.2

Render an AsciiDoc document to HTML, following Asciidoctor's HTML5 converter
Documentation
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
//! The stylesheet embedded in a standalone page.
//!
//! It targets Asciidoctor's class names, so a document rendered here looks
//! right without pulling in Asciidoctor's own (much larger) stylesheet, and a
//! reader who prefers a dark theme gets one.
//!
//! # Three parts, because a host needs them separately
//!
//! A host that renders a `--fragment` into a page of its own — a documentation
//! site with a navigation tree and a toolbar — cannot use the whole of this:
//! the rules for `#header`, `#content` and the outline describe a page it is
//! not making. But it *must* have the rest, and not a stylesheet of its own
//! written to look similar.
//!
//! The reason is [`VARIABLES`]. The markup this crate emits is styled by
//! [`DOCUMENT`], and a mermaid diagram it draws carries theme overrides written
//! against those custom properties — `fill: var(--code-bg)` and its like. A
//! host that declared its own names for those colours would leave every one of
//! those overrides resolving to nothing, and `fill` falling back to its initial
//! value: a diagram of solid black boxes, with nothing in the page to say why.
//!
//! So the three are exposed separately, and a host composes them: the
//! properties at the top level where a diagram can reach them, the document
//! rules scoped to wherever the document sits, and its own frame in place of
//! [`PAGE`].

/// The custom properties every other rule — and every drawn diagram — reads.
///
/// A host that supplies its own page declares these at the top level, unscoped:
/// a diagram's own theme overrides look them up from inside the `<svg>`, and a
/// property declared out of their reach is a property that does not exist.
pub(crate) const VARIABLES: &str = r"
:root {
  color-scheme: light dark;
  --bg: #fdfdfd;
  --fg: #1c1e21;
  --muted: #656d77;
  --rule: #dcdfe4;
  --accent: #1565a8;
  --code-bg: #f5f6f8;
  --sidebar-bg: #f2f4f7;
  /* Asciidoctor's own admonition colours. */
  --admon-note: #19407c;
  --admon-tip: #b58900;
  --admon-important: #bf6900;
  --admon-caution: #bf3400;
  --admon-warning: #bf0000;
  /* Syntax highlighting. */
  --hl-comment: #656d77;
  --hl-keyword: #cf222e;
  --hl-string: #0a3069;
  --hl-number: #0550ae;
  --hl-function: #6639ba;
  --hl-type: #953800;
  --hl-constant: #0550ae;
  --hl-property: #0550ae;
  --hl-tag: #116329;
  --hl-punctuation: #57606a;
}

@media (prefers-color-scheme: dark) {
  :root {
    --bg: #16181c;
    --fg: #dfe3e8;
    --muted: #9aa3ad;
    --rule: #2e3339;
    --accent: #6cb2f0;
    --code-bg: #1e2126;
    --sidebar-bg: #1e2126;
    /* Lightened, because Asciidoctor's are chosen against a white page. */
    --admon-note: #6ea8e8;
    --admon-tip: #e3b341;
    --admon-important: #e08c3e;
    --admon-caution: #f0764a;
    --admon-warning: #f0716f;
    --hl-comment: #8b949e;
    --hl-keyword: #ff7b72;
    --hl-string: #a5d6ff;
    --hl-number: #79c0ff;
    --hl-function: #d2a8ff;
    --hl-type: #ffa657;
    --hl-constant: #79c0ff;
    --hl-property: #79c0ff;
    --hl-tag: #7ee787;
    --hl-punctuation: #8b949e;
  }
}

";

/// The rules for a document's own content.
///
/// Every selector here is either a class Asciidoctor emits or an element inside
/// a document, so the whole block can be nested under wherever a host puts the
/// document — `article.doc { … }` — and reach nothing else.
pub(crate) const DOCUMENT: &str = r#"/* Footnote definitions, gathered under a rule at the foot of the page. */
#footnotes { margin-top: 2.5rem; font-size: 0.9rem; color: var(--muted); }
#footnotes hr { margin: 0 0 1rem; }
#footnotes .footnote { margin-bottom: 0.5rem; padding-left: 1.5rem; text-indent: -1.5rem; }
#footnotes .footnote > a { font-weight: 600; }

h1, h2, h3, h4, h5, h6 { line-height: 1.25; margin: 2rem 0 0.75rem; font-weight: 600; }
h1 { font-size: 2rem; margin-top: 0; }
h2 { font-size: 1.6rem; padding-bottom: 0.3rem; border-bottom: 1px solid var(--rule); }
h3 { font-size: 1.3rem; }
h4 { font-size: 1.1rem; }
h5, h6 { font-size: 1rem; }
h1 .subtitle { color: var(--muted); font-weight: 400; }

/* `:sectanchors:` puts an empty link before a heading, which needs a mark of
   its own to be worth anything. It sits in the margin so the heading does not
   move when it appears, and appears when the heading is under the pointer or
   the link itself has the keyboard. */
h1 .anchor, h2 .anchor, h3 .anchor, h4 .anchor, h5 .anchor, h6 .anchor {
  position: absolute; margin-left: -1em; width: 1em;
  opacity: 0; text-align: center; font-weight: 400; color: var(--muted);
}
h1 .anchor::before, h2 .anchor::before, h3 .anchor::before,
h4 .anchor::before, h5 .anchor::before, h6 .anchor::before { content: "\00A7"; }
h1:hover .anchor, h2:hover .anchor, h3:hover .anchor,
h4:hover .anchor, h5:hover .anchor, h6:hover .anchor,
.anchor:focus { opacity: 1; }

/* `:sectlinks:` makes the heading itself a link, which should still read as a
   heading rather than as something to click. */
h1 > .link, h2 > .link, h3 > .link, h4 > .link, h5 > .link, h6 > .link {
  color: inherit;
}

/* A link in a run of text is underlined rather than only coloured. The accent
   is 2.75:1 against the body colour in the light scheme and 1.76:1 in the dark
   one, and a reader who does not separate those two colours would have nothing
   else to go on. Where a whole block is links — the outline, a heading, an
   image — the underline is noise and comes off again. */
a { color: var(--accent); text-decoration: underline; text-underline-offset: 0.15em; }
a:hover { text-decoration-thickness: 2px; }
a.image, a.anchor { text-decoration: none; }
h1 > .link, h2 > .link, h3 > .link, h4 > .link, h5 > .link, h6 > .link { text-decoration: none; }
h1 > .link:hover, h2 > .link:hover, h3 > .link:hover, h4 > .link:hover,
h5 > .link:hover, h6 > .link:hover { text-decoration: underline; }

p { margin: 0 0 1rem; }
hr { border: 0; border-top: 1px solid var(--rule); margin: 2rem 0; }

.details { color: var(--muted); font-size: 0.9rem; margin-bottom: 1.5rem; }
.details .detail { line-height: 1.5; }
.details .label { font-weight: 600; }
.details .email a { color: inherit; }
.details .tag { display: inline-block; padding: 0.02em 0.5em; border: 1px solid var(--rule); border-radius: 999px; font-size: 0.9em; }
/* The remark is a sentence about the revision, not another labelled value. */
.details .remark { margin-top: 0.75rem; font-style: italic; }
.title { font-style: italic; color: var(--muted); margin-bottom: 0.4rem; font-size: 0.95rem; }

/* Code */
code, pre { font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace; font-size: 0.9em; }
code { background: var(--code-bg); padding: 0.1em 0.35em; border-radius: 3px; }
pre { background: var(--code-bg); padding: 0.9rem 1rem; border-radius: 6px; overflow-x: auto; line-height: 1.45; }
pre code { background: none; padding: 0; }
.listingblock, .literalblock { margin-bottom: 1.25rem; }

/* Syntax highlighting. Several tree-sitter captures share a colour on purpose:
   a builtin function is still a function to a reader, and a listing that picks
   out everything picks out nothing. */
.hl-comment { color: var(--hl-comment); font-style: italic; }
.hl-keyword { color: var(--hl-keyword); }
.hl-string { color: var(--hl-string); }
.hl-number { color: var(--hl-number); }
.hl-constant { color: var(--hl-constant); }
.hl-function { color: var(--hl-function); }
.hl-type { color: var(--hl-type); }
.hl-property { color: var(--hl-property); }
.hl-attr { color: var(--hl-property); }
.hl-tag { color: var(--hl-tag); }
.hl-escape { color: var(--hl-number); }
.hl-label { color: var(--hl-type); }
.hl-punctuation, .hl-operator { color: var(--hl-punctuation); }
/* Variables and parameters are left in the body colour: they are most of a
   listing, and colouring them leaves nothing for the eye to catch on. */
.hl-variable, .hl-parameter, .hl-unknown { color: inherit; }
/* A callout keeps its own weight against whatever the highlighter did. */
.listingblock .conum { color: var(--accent); font-weight: 600; font-style: normal; }

/* A callout mark, drawn rather than written: Asciidoctor's markup for it names
   a Font Awesome glyph, and a page this tool produced has no way to pull in
   that webfont. The number is in the markup as data, so a circle and a counter
   are the whole of it, and the `(1)` beside it — which is what a page with no
   stylesheet shows — is hidden once the mark is drawn. */
.conum[data-value] {
  display: inline-block; width: 1.3em; height: 1.3em; line-height: 1.3em;
  border-radius: 50%; background: var(--accent); color: var(--bg);
  text-align: center; font-family: inherit; font-size: 0.8em; font-style: normal;
  font-weight: 600; vertical-align: 0.05em;
}
.conum[data-value]::after { content: attr(data-value); }
.conum[data-value] + b { display: none; }
/* The list beneath the block marks its items the same way, so an item and the
   line it annotates carry the same mark. */
.colist.conums > ol { list-style: none; padding-left: 0; counter-reset: conum; }
.colist.conums > ol > li { counter-increment: conum; position: relative; padding-left: 2em; }
.colist.conums > ol > li::before {
  content: counter(conum); position: absolute; left: 0; top: 0.1em;
  display: inline-block; width: 1.3em; height: 1.3em; line-height: 1.3em;
  border-radius: 50%; background: var(--accent); color: var(--bg);
  text-align: center; font-size: 0.8em; font-weight: 600;
}

/* Quotes */
.quoteblock { margin: 1.25rem 0; }
.quoteblock blockquote { margin: 0; padding: 0.25rem 0 0.25rem 1.25rem; border-left: 4px solid var(--rule); color: var(--fg); }
.verseblock pre.content { background: none; padding: 0 0 0 1.25rem; border-left: 4px solid var(--rule); white-space: pre-wrap; }
.attribution { color: var(--muted); font-size: 0.9rem; margin-top: 0.5rem; }
.attribution cite { font-style: italic; }

/* A stem block is a displayed equation: it stands apart from the text the way a
   figure does, and a long one scrolls rather than pushing the column wide. Until
   a maths renderer is loaded into the page it shows its own delimiters, which is
   the honest thing for it to show. */
.stemblock { margin: 1.5rem 0; text-align: center; }
.stemblock > .content { overflow-x: auto; }

/* Admonitions, as a box with a coloured edge rather than Asciidoctor's icon
   column and rule. The edge carries the colour, so the block says what kind of
   aside it is from across the page — without the icon having to be large enough
   to read as one, and without a reader who does not separate those five hues
   losing the boundary of the aside itself. */
.admonitionblock {
  margin: 1.4rem 0;
  border: 1px solid var(--rule);
  border-left: 3px solid var(--admon);
  border-radius: 6px;
  background: var(--sidebar-bg);
}
.admonitionblock > table { width: 100%; border-collapse: collapse; border: 0; background: none; }
/* The icon is centred against the whole admonition rather than sitting at its
   top: the mark stands for the block, and a tall one left it stranded. */
.admonitionblock td.icon { width: 3.5rem; text-align: center; vertical-align: middle; padding: 0.9rem 0 0.9rem 0.9rem; color: var(--admon); }
.admonitionblock td.icon .icon { width: 1.75rem; height: 1.75rem; }
.admonitionblock td.icon .title { font-style: normal; font-weight: 700; text-transform: uppercase; font-size: 0.8rem; letter-spacing: 0.03em; margin: 0; color: var(--admon); }
.admonitionblock td.content { padding: 0.9rem 1rem; vertical-align: middle; }
.admonitionblock td.content > :last-child { margin-bottom: 0; }
.admonitionblock td.content > .title { text-transform: uppercase; font-style: normal; font-weight: 600; color: var(--fg); }
.admonitionblock.note { --admon: var(--admon-note); }
.admonitionblock.tip { --admon: var(--admon-tip); }
.admonitionblock.important { --admon: var(--admon-important); }
.admonitionblock.caution { --admon: var(--admon-caution); }
.admonitionblock.warning { --admon: var(--admon-warning); }

/* Sidebars, examples, open blocks */
.sidebarblock { background: var(--sidebar-bg); border-radius: 6px; padding: 1rem 1.25rem; margin: 1.25rem 0; }
.exampleblock > .content { border: 1px solid var(--rule); border-radius: 6px; padding: 1rem 1.25rem; }
.exampleblock, .openblock { margin: 1.25rem 0; }
.exampleblock details > summary { cursor: pointer; }

/* Lists */
ul, ol { padding-left: 1.5rem; }
.ulist, .olist, .dlist, .colist, .qlist { margin-bottom: 1.25rem; }
.ulist li p, .olist li p, .dlist dd p { margin-bottom: 0.35rem; }
.checklist { list-style: none; padding-left: 0.5rem; }
/* The bullet styles an author can ask for by name. `unstyled` and `no-bullet`
   differ in whether the text keeps its indent; `inline` runs the items along
   one line, which suits a row of links under a heading. */
ul.square { list-style-type: square; }
ul.circle { list-style-type: circle; }
ul.disc { list-style-type: disc; }
ul.none, ul.no-bullet { list-style: none; }
ul.unstyled { list-style: none; padding-left: 0; }
ul.inline { list-style: none; padding-left: 0; display: flex; flex-wrap: wrap; gap: 0 1rem; }
ul.inline > li > p { margin: 0; }
/* A styled description list — `[glossary]`, say — carries no class on its
   terms, so the term is styled by where it sits rather than by what it is. */
.dlist dt { font-weight: 600; margin-top: 0.75rem; }
dd { margin-left: 1.5rem; }
.hdlist table { border-collapse: collapse; }
.hdlist td { padding: 0.25rem 1rem 0.25rem 0; vertical-align: top; }
.hdlist td.hdlist1 { font-weight: 600; }

/* Images and media */
.imageblock, .videoblock, .audioblock { margin: 1.5rem 0; }
.imageblock .content, .videoblock .content { text-align: center; }
img, video, audio { max-width: 100%; height: auto; }
.imageblock .title { text-align: center; margin-top: 0.5rem; }

/* Diagrams */
.diagram > .content { text-align: center; overflow-x: auto; }
pre.mermaid { background: none; padding: 0; margin: 0; text-align: center; line-height: normal; }
/* A diagram is held to the column, whatever width it was drawn at. The scroll
   on the box above is the fallback for one that cannot be made to fit. */
pre.mermaid svg { display: inline-block; vertical-align: top; max-width: 100%; height: auto; }
/* Until the drawing module runs, the source is what there is to show. */
pre.mermaid:not([data-processed]) { text-align: left; background: var(--code-bg); padding: 0.9rem 1rem; border-radius: 6px; }

/* Tables */
table.tableblock { border-collapse: collapse; margin: 1.5rem 0; font-size: 0.95rem; }
table.tableblock.stretch { width: 100%; }
table.tableblock.fit-content { width: auto; }
table.tableblock caption.title { text-align: left; margin-bottom: 0.5rem; }
table.tableblock th, table.tableblock td { padding: 0.5rem 0.75rem; vertical-align: top; }
table.tableblock th { font-weight: 600; text-align: left; }
table.tableblock p.tableblock { margin: 0; }
table.frame-all { border: 1px solid var(--rule); }
table.frame-ends { border-top: 1px solid var(--rule); border-bottom: 1px solid var(--rule); }
table.frame-sides { border-left: 1px solid var(--rule); border-right: 1px solid var(--rule); }
table.grid-all th, table.grid-all td { border: 1px solid var(--rule); }
table.grid-rows th, table.grid-rows td { border-top: 1px solid var(--rule); border-bottom: 1px solid var(--rule); }
table.grid-cols th, table.grid-cols td { border-left: 1px solid var(--rule); border-right: 1px solid var(--rule); }
table.stripes-even tbody tr:nth-child(even),
table.stripes-odd tbody tr:nth-child(odd),
table.stripes-all tbody tr { background: var(--code-bg); }
table.stripes-hover tbody tr:hover { background: var(--code-bg); }
/* A cell's own alignment has to out-specify the defaults above, or a header
   cell would silently ignore the `^` or `>` its author wrote. */
table.tableblock td.halign-center, table.tableblock th.halign-center { text-align: center; }
table.tableblock td.halign-right, table.tableblock th.halign-right { text-align: right; }
table.tableblock td.halign-left, table.tableblock th.halign-left { text-align: left; }
table.tableblock td.valign-middle, table.tableblock th.valign-middle { vertical-align: middle; }
table.tableblock td.valign-bottom, table.tableblock th.valign-bottom { vertical-align: bottom; }
/* A literal cell is still a table cell: the code-block chrome would make the
   row taller than its neighbours and push its text out of line with them. */
table.tableblock .literal pre { background: none; padding: 0; border-radius: 0; }

"#;

/// The outline's own look, separately from where a page docks it.
///
/// A host that lays out its own page still wants the entries to look like
/// entries; what it does not want is the frame around them. Keeping the two
/// apart is what lets it take one without the other.
pub(crate) const TOC: &str = r"/* The outline, as a column of entries with a mark against the one being read,
   rather than a boxed list. There is no box and no rail: a gutter is held open
   down the side of every entry with a border that is not painted, and only the
   section being read draws in it, so the mark has somewhere to go and nothing
   moves when it arrives. The title is set small and lettered, because at the
   head of a list of headings it is a label rather than another heading. */
#toc { border: 0; padding: 0; margin: 1.5rem 0 2rem; }
#toctitle {
  margin: 0 0 0.5rem;
  font-size: 0.6875rem;
  font-weight: 700;
  letter-spacing: 0.08em;
  text-transform: uppercase;
  color: var(--muted);
}
#toc ul { list-style: none; margin: 0; padding: 0; }
#toc a {
  display: block;
  padding: 0.15rem 0 0.15rem 0.6rem;
  border-left: 2px solid transparent;
  color: var(--muted);
  line-height: 1.4;
  font-size: 0.875rem;
}
/* A subsection is indented by its own text, not by the list it sits in, so the
   gutter stays one column all the way down. Indenting the list would carry the
   border along with it, and then a mark spanning a section and its subsections
   comes out as a flight of steps instead of a line. */
#toc .sectlevel2 > li > a { padding-left: 1.35rem; }
#toc .sectlevel3 > li > a { padding-left: 2.1rem; }
#toc .sectlevel4 > li > a { padding-left: 2.85rem; }
#toc .sectlevel5 > li > a { padding-left: 3.6rem; }
#toc a:hover { color: var(--fg); }
/* `is-active` is put on by the outline's own script; see `reading`. */
#toc a.is-active { border-left-color: var(--accent); color: var(--accent); }

#toc a { text-decoration: none; }
";

/// The rules for the page a standalone document is put in: the reset, the body,
/// the three landmarks, and where the outline docks.
///
/// A host with a page of its own replaces this and keeps the others — the
/// outline's own look is in [`TOC`], which such a host does still want.
pub(crate) const PAGE: &str = r#"* { box-sizing: border-box; }

body {
  margin: 0;
  background: var(--bg);
  color: var(--fg);
  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
  font-size: 16px;
  line-height: 1.6;
}

/* The three landmarks the page is made of. `#footnotes` is not among them: it
   sits inside `#content` so that it belongs to a landmark, and constraining it
   again there would indent it and narrow it a second time. */
#header, #content, #footer { max-width: 50rem; margin: 0 auto; padding: 0 1.25rem; }
#header { padding-top: 2.5rem; }
#footer { padding-bottom: 3rem; color: var(--muted); font-size: 0.85rem; }
/* Side-docked table of contents on wide screens */
@media (min-width: 62rem) {
  body.toc2 #toc {
    position: fixed;
    top: 0;
    bottom: 0;
    width: 16rem;
    overflow-y: auto;
    margin: 0;
    padding: 2rem 1.25rem;
  }
  /* Docked, but not panelled: the page's own ground and no rule down the edge,
     so the outline reads as part of the document rather than as a tray bolted
     to the side of it. The margins below are what separate the two. */
  body.toc2.toc-left #toc { left: 0; }
  body.toc2.toc-right #toc { right: 0; }
  body.toc2.toc-left #header,
  body.toc2.toc-left #content,
  body.toc2.toc-left #footer { margin-left: calc(16rem + 2rem); }
  body.toc2.toc-right #header,
  body.toc2.toc-right #content,
  body.toc2.toc-right #footer { margin-right: calc(16rem + 2rem); }
}
"#;