Skip to content

Commit b533004

Browse files
committed
Move generator into <footer>
Resolves #2532
1 parent 7ed0e46 commit b533004

File tree

4 files changed

+24
-12
lines changed

4 files changed

+24
-12
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
- Added `gitRevision:short` placeholder option to `--sourceLinkTemplate` option, #2529.
66
Links generated by TypeDoc will now default to using the non-short git revision.
7+
- Moved "Generated by TypeDoc" footer into a `<footer>` tag, added `footer.begin` and `footer.end`
8+
render hooks for use by custom plugins, #2532.
79

810
### Bug Fixes
911

src/lib/output/renderer.ts

+10
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,16 @@ export interface RendererHooks {
8181
* Applied immediately after calling `context.pageSidebar`.
8282
*/
8383
"pageSidebar.end": [DefaultThemeRenderContext];
84+
85+
/**
86+
* Applied immediately before the "Generated by TypeDoc" link in the footer.
87+
*/
88+
"footer.begin": [DefaultThemeRenderContext];
89+
90+
/**
91+
* Applied immediately after the "Generated by TypeDoc" link in the footer.
92+
*/
93+
"footer.end": [DefaultThemeRenderContext];
8494
}
8595

8696
/**

src/lib/output/themes/default/partials/footer.tsx

+9-6
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
33

44
export function footer(context: DefaultThemeRenderContext) {
55
const hideGenerator = context.options.getValue("hideGenerator");
6-
if (!hideGenerator)
7-
return (
8-
<div class="tsd-generator">
9-
<p>
6+
return (
7+
<footer>
8+
{context.hook("footer.begin")}
9+
{hideGenerator || (
10+
<p class="tsd-generator">
1011
{"Generated using "}
1112
<a href="https://typedoc.org/" target="_blank">
1213
TypeDoc
1314
</a>
1415
</p>
15-
</div>
16-
);
16+
)}
17+
{context.hook("footer.end")}
18+
</footer>
19+
);
1720
}

static/style.css

+3-6
Original file line numberDiff line numberDiff line change
@@ -327,17 +327,14 @@ dd {
327327
}
328328

329329
/* Footer */
330-
.tsd-generator {
330+
footer {
331331
border-top: 1px solid var(--color-accent);
332332
padding-top: 1rem;
333333
padding-bottom: 1rem;
334334
max-height: 3.5rem;
335335
}
336-
337-
.tsd-generator > p {
338-
margin-top: 0;
339-
margin-bottom: 0;
340-
padding: 0 1rem;
336+
.tsd-generator {
337+
margin: 0 1em;
341338
}
342339

343340
.container-main {

0 commit comments

Comments
 (0)