Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions scripts/typedoc-github-theme-fixes.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
/**
* Local overrides for typedoc-github-theme typography styles.
*
* Upstream PR: https://github.com/JulianWowra/typedoc-github-theme/pull/7
*
* Remove this file once the PR is merged and the theme dependency is updated.
*/

/*
* Typography (all markdown content)
*/

.tsd-typography {
line-height: 1.5;
}

/* Underline plain links; TypeDoc adds classes to code refs and anchor icons */
.tsd-typography a:not([class]),
.tsd-typography a.external {
text-decoration: underline;
}

.tsd-typography code {
margin: 0;
}

.tsd-typography ul {
list-style: disc;
}

.tsd-typography ul ul {
list-style: circle;
}

.tsd-typography ul ul ul {
list-style: square;
}

.tsd-typography ul,
.tsd-typography ol {
padding-left: 32px;
}

.tsd-typography pre {
padding: 16px;
overflow: auto;
}

.tsd-typography strong {
font-weight: 600;
}

/*
* Typography headings (document pages only)
*
* Heading styles are scoped to .tsd-panel.tsd-typography to avoid affecting
* JSDoc comment prose (.tsd-comment.tsd-typography) on API pages.
*/

/* Override heading margin for the first element (matches GitHub's markdown-body) */
.tsd-panel.tsd-typography > :first-child {
margin-top: 0 !important;
}

.tsd-panel.tsd-typography h1,
.tsd-panel.tsd-typography h2,
.tsd-panel.tsd-typography h3,
.tsd-panel.tsd-typography h4,
.tsd-panel.tsd-typography h5,
.tsd-panel.tsd-typography h6 {
margin-top: 24px;
margin-bottom: 16px;
font-weight: 600;
line-height: 1.25;
}

.tsd-panel.tsd-typography h1 {
font-size: 2em;
padding-bottom: 0.3em;
border-bottom: 1px solid var(--color-accent);
}

.tsd-panel.tsd-typography h2 {
font-size: 1.5em;
padding-bottom: 0.3em;
border-bottom: 1px solid var(--color-accent);
}

.tsd-panel.tsd-typography h3 {
font-size: 1.25em;
}

.tsd-panel.tsd-typography h4 {
font-size: 1em;
}

.tsd-panel.tsd-typography h5 {
font-size: 0.875em;
}

.tsd-panel.tsd-typography h6 {
font-size: 0.85em;
color: var(--color-text-aside);
}

.tsd-panel.tsd-typography > h1,
.tsd-panel.tsd-typography > h2,
.tsd-panel.tsd-typography > h3 {
margin-left: 0;
margin-right: 0;
padding: 0;
}

.tsd-panel.tsd-typography > h1,
.tsd-panel.tsd-typography > h2 {
padding-bottom: 0.3em;
}
3 changes: 3 additions & 0 deletions typedoc.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ const config = {
"./scripts/typedoc-plugin-fix-mermaid-entities.mjs",
"@boneskull/typedoc-plugin-mermaid",
],
// Remove once typedoc-github-theme merges upstream fix:
// https://github.com/JulianWowra/typedoc-github-theme/pull/7
customCss: "./scripts/typedoc-github-theme-fixes.css",
ignoredHighlightLanguages: ["mermaid"],
};

Expand Down
Loading