Merge pull request #462 from jonathanhefner/remove-typedoc-theme-css-patch
Upgrade `typedoc-github-theme` to v0.4.0 and remove local CSS workaround
This commit is contained in:
commit
8dbc06a355
4 changed files with 5 additions and 125 deletions
8
package-lock.json
generated
8
package-lock.json
generated
|
|
@ -39,7 +39,7 @@
|
||||||
"ts-to-zod": "^5.1.0",
|
"ts-to-zod": "^5.1.0",
|
||||||
"tsx": "^4.21.0",
|
"tsx": "^4.21.0",
|
||||||
"typedoc": "^0.28.14",
|
"typedoc": "^0.28.14",
|
||||||
"typedoc-github-theme": "^0.3.1",
|
"typedoc-github-theme": "^0.4.0",
|
||||||
"typescript": "^5.9.3",
|
"typescript": "^5.9.3",
|
||||||
"zod": "^4.1.13"
|
"zod": "^4.1.13"
|
||||||
},
|
},
|
||||||
|
|
@ -9210,9 +9210,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/typedoc-github-theme": {
|
"node_modules/typedoc-github-theme": {
|
||||||
"version": "0.3.1",
|
"version": "0.4.0",
|
||||||
"resolved": "https://registry.npmjs.org/typedoc-github-theme/-/typedoc-github-theme-0.3.1.tgz",
|
"resolved": "https://registry.npmjs.org/typedoc-github-theme/-/typedoc-github-theme-0.4.0.tgz",
|
||||||
"integrity": "sha512-j6PmkAGmf/MGCzYjQcUH6jS9djPsNl/IoTXooxC+MoeMkBhbmPyKJlpR6Lw12BLoe2OYpYA2J1KMktUJXp/8Sw==",
|
"integrity": "sha512-lo/hr4EFZxq0SsMGeAscKUzljIKFgrJf5fb4nOAJcqaiSShQv7kzwF6M1s2fVRvUyx6UsmD4zEb+MtKkbucYpg==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"engines": {
|
"engines": {
|
||||||
|
|
|
||||||
|
|
@ -99,7 +99,7 @@
|
||||||
"ts-to-zod": "^5.1.0",
|
"ts-to-zod": "^5.1.0",
|
||||||
"tsx": "^4.21.0",
|
"tsx": "^4.21.0",
|
||||||
"typedoc": "^0.28.14",
|
"typedoc": "^0.28.14",
|
||||||
"typedoc-github-theme": "^0.3.1",
|
"typedoc-github-theme": "^0.4.0",
|
||||||
"typescript": "^5.9.3",
|
"typescript": "^5.9.3",
|
||||||
"zod": "^4.1.13"
|
"zod": "^4.1.13"
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -1,117 +0,0 @@
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
|
|
@ -46,9 +46,6 @@ const config = {
|
||||||
"./scripts/typedoc-plugin-fix-mermaid-entities.mjs",
|
"./scripts/typedoc-plugin-fix-mermaid-entities.mjs",
|
||||||
"@boneskull/typedoc-plugin-mermaid",
|
"@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"],
|
ignoredHighlightLanguages: ["mermaid"],
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue