typedoc-github-theme 0.2.0 → 0.3.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 KillerJulian
+Copyright (c) 2024 Julian Wowra (development@julianwowra.de)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,22 +6,22 @@ This [TypeDoc](https://github.com/TypeStrong/typedoc) theme is designed to provi
 
 ## Example
 
-[![Example](./example.png)](https://killerjulian.github.io/typedoc-github-theme/)
+[![Example](./example.png)](https://julianwowra.github.io/typedoc-github-theme/)
 
 ## Usage
 
 **Install the package with your favourite package manager:**
 
 ```text
-npm install typedoc-github-theme
+npm install typedoc-github-theme --save-dev
 ```
 
 ```text
-pnpm install typedoc-github-theme
+pnpm add typedoc-github-theme --save-dev
 ```
 
 ```text
-yarn add typedoc-github-theme
+yarn add typedoc-github-theme --dev
 ```
 
 **Use the theme when generating your documentation:**
@@ -38,10 +38,10 @@ npx typedoc src --plugin typedoc-github-theme
 
 ## Author
 
-👤 **KillerJulian <info@killerjulian.de>**
+👤 **Julian Wowra <development@julianwowra.de>**
 
-- Github: [@KillerJulian](https://github.com/KillerJulian)
+- Github: [@JulianWowra](https://github.com/JulianWowra)
 
 ## 🤝 Contributing
 
-Contributions, issues and feature requests are welcome!<br />Feel free to check the [issues page](https://github.com/KillerJulian/typedoc-github-theme/issues). You can also take a look at the [contributing guide](https://github.com/KillerJulian/typedoc-github-theme/blob/master/CONTRIBUTING.md).
+Contributions, issues and feature requests are welcome!<br />Feel free to check the [issues page](https://github.com/JulianWowra/typedoc-github-theme/issues). You can also take a look at the [contributing guide](https://github.com/JulianWowra/typedoc-github-theme/blob/main/CONTRIBUTING.md).

package/dist/GitHubTheme.js

@@ -26,6 +26,6 @@ export class GitHubTheme extends DefaultTheme {
         });
     }
     getRenderContext(pageEvent) {
-        return new GitHubThemeContext(this, pageEvent, this.application.options);
+        return new GitHubThemeContext(this.router, this, pageEvent, this.application.options);
     }
 }

package/dist/index.js

@@ -6,7 +6,7 @@ export function load(app) {
     app.renderer.defineTheme('typedoc-github-theme', GitHubTheme);
     app.on('bootstrapEnd', () => {
         if (app.options.isSet('theme') && app.options.getValue('theme') !== 'typedoc-github-theme') {
-            return app.logger.warn(`The theme'typedoc-github-theme' is not used because another theme (${app.options.getValue('theme')}) was specified!`);
+            return app.logger.warn(`The theme 'typedoc-github-theme' is not used because another theme (${app.options.getValue('theme')}) was specified!`);
         }
         app.options.setValue('theme', 'typedoc-github-theme');
     });

package/dist/partials/footer.js

@@ -14,7 +14,7 @@ function generatorDisplay(context) {
         'Generated using ',
         JSX.createElement("a", { href: "https://typedoc.org/", target: "_blank" }, "TypeDoc"),
         ' with ',
-        JSX.createElement("a", { href: "https://github.com/KillerJulian/typedoc-github-theme", target: "_blank" }, "typedoc-github-theme")));
+        JSX.createElement("a", { href: "https://github.com/JulianWowra/typedoc-github-theme", target: "_blank" }, "typedoc-github-theme")));
 }
 function customFooterDisplay(context) {
     const customFooterHtml = context.options.getValue('customFooterHtml');

package/package.json

@@ -1,27 +1,31 @@
 {
 	"name": "typedoc-github-theme",
 	"description": "Elegant and seamless look and feel for your TypeScript documentation on GitHub Pages",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"type": "module",
-	"repository": "https://github.com/KillerJulian/typedoc-github-theme",
-	"homepage": "https://killerjulian.github.io/typedoc-github-theme/",
-	"author": "KillerJulian <info@killerjulian.de>",
+	"repository": "https://github.com/JulianWowra/typedoc-github-theme",
+	"homepage": "https://julianwowra.github.io/typedoc-github-theme/",
+	"author": "Julian Wowra <development@julianwowra.de>",
 	"license": "MIT",
-	"packageManager": "pnpm@9.14.3",
+	"publishConfig": {
+		"provenance": true
+	},
+	"packageManager": "pnpm@10.7.1",
 	"dependencies": {},
 	"peerDependencies": {
-		"typedoc": "^0.27.1"
+		"typedoc": "~0.28.0"
 	},
 	"devDependencies": {
-		"@types/node": "^18.19.67",
-		"eslint": "9.15.0",
-		"eslint-config-prettier": "9.1.0",
-		"prettier": "3.4.1",
-		"typedoc": "~0.27.1",
-		"typescript": "5.7.2",
-		"typescript-eslint": "8.16.0"
+		"@eslint/js": "9.24.0",
+		"@types/node": "^18.19.86",
+		"eslint": "9.24.0",
+		"eslint-config-prettier": "10.1.1",
+		"prettier": "3.5.3",
+		"typedoc": "~0.28.1",
+		"typescript": "5.8.3",
+		"typescript-eslint": "8.29.0"
 	},
 	"scripts": {
 		"build": "pnpm build:lib && pnpm build:docs",

package/src/assets/typedoc-github-style.css

@@ -7,8 +7,9 @@
 	--light-color-background: #ffffff;
 	--light-color-background-secondary: #f6f8fa;
 	--light-color-background-navbar: #f6f8fa;
+	--light-color-background-overlay: #c8d1da66;
 
-	--light-color-accent: #eff2f5;
+	--light-color-accent: #d1d9e0;
 
 	--light-color-text: #1f2328;
 	--light-color-text-aside: #59636e;
@@ -28,8 +29,9 @@
 	--dark-color-background: #0d1117;
 	--dark-color-background-secondary: #151b23;
 	--dark-color-background-navbar: #010409;
+	--dark-color-background-overlay: #21283066;
 
-	--dark-color-accent: #262c36;
+	--dark-color-accent: #383e48;
 
 	--dark-color-text: #f0f6fc;
 	--dark-color-text-aside: #9198a1;
@@ -47,6 +49,7 @@
 
 	/* Link colors */
 	--color-warning-text: var(--color-text);
+	--color-contrast-text: var(--color-text);
 	--color-icon-background: var(--color-background);
 	--color-focus-outline: var(--color-accent);
 }
@@ -54,6 +57,7 @@
 @media (prefers-color-scheme: light) {
 	:root {
 		--color-background-navbar: var(--light-color-background-navbar);
+		--color-background-overlay: var(--light-color-background-overlay);
 		--color-warning-border: var(--light-color-warning-border);
 	}
 }
@@ -61,17 +65,20 @@
 @media (prefers-color-scheme: dark) {
 	:root {
 		--color-background-navbar: var(--dark-color-background-navbar);
+		--color-background-overlay: var(--dark-color-background-overlay);
 		--color-warning-border: var(--dark-color-warning-border);
 	}
 }
 
 :root[data-theme='light'] {
 	--color-background-navbar: var(--light-color-background-navbar);
+	--color-background-overlay: var(--light-color-background-overlay);
 	--color-warning-border: var(--light-color-warning-border);
 }
 
 :root[data-theme='dark'] {
 	--color-background-navbar: var(--dark-color-background-navbar);
+	--color-background-overlay: var(--dark-color-background-overlay);
 	--color-warning-border: var(--dark-color-warning-border);
 }
 
@@ -80,8 +87,8 @@
  */
 
 :root {
-	--font-family-text: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', Helvetica, Arial, sans-serif, 'Apple Color Emoji',
-		'Segoe UI Emoji';
+	--font-family-text:
+		-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji';
 	--font-family-code: ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
 }
 
@@ -89,20 +96,6 @@ body {
 	font-family: var(--font-family-text);
 }
 
-/*
- * Headlines
- */
-
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-	margin-top: 1em;
-	margin-bottom: 0.5em;
-}
-
 /*
  * Links
  */
@@ -285,38 +278,47 @@ code.tsd-tag {
 	border-bottom-color: var(--color-accent);
 }
 
-#tsd-search.has-focus {
-	background-color: var(--color-background-navbar);
+.tsd-toolbar-contents a.title:hover {
+	color: var(--color-text);
 }
 
-#tsd-search .results,
-#tsd-search .results li,
-#tsd-search .results li:nth-child(2n) {
-	background-color: var(--color-background-navbar);
+/*
+ * Search
+ */
+
+#tsd-search-trigger {
+	width: unset;
+	border: unset;
+	background-color: unset;
+	transition: opacity 0.15s ease-in-out;
 }
 
-#tsd-search .results li {
-	margin-bottom: 0px;
+#tsd-search-trigger:hover {
+	opacity: 1;
 }
 
-#tsd-search .results li a {
-	color: var(--color-text);
+#tsd-search-input,
+#tsd-search-input:focus-visible {
+	background-color: transparent;
+	border: 1px solid var(--color-focus-outline);
 }
 
-#tsd-search .results li:hover:not(.no-results) {
-	background-color: var(--color-accent);
+#tsd-search-status:not(:empty) {
+	min-height: unset;
+	padding-top: 1.5rem;
+	padding-bottom: 0.5rem;
 }
 
-#tsd-search .results {
-	border-style: solid;
-	border-width: 1px;
-	border-color: var(--color-accent);
-	border-radius: 0px 0px 6px 6px;
-	overflow: hidden;
+#tsd-search-results > li:is(:hover, [aria-selected='true']) {
+	background-color: color-mix(in srgb, var(--color-text-aside), #0000 88%);
+}
+
+#tsd-search-results > li > a:hover {
+	text-decoration: unset;
 }
 
-#tsd-search .results .no-results {
-	padding: calc(4px + 0.25rem);
+#tsd-overlay {
+	background-color: var(--color-background-overlay);
 }
 
 /*
@@ -422,9 +424,11 @@ footer p {
 }
 
 /*
- * Fix collapse arrow position
+ * Fix collapse arrows position
  */
 
 .tsd-accordion-summary svg {
 	transition: transform 0.1s ease-in-out;
+	margin-top: auto;
+	margin-bottom: auto;
 }