Skip to content

Commit

Permalink
Update Auth SDK Ref guide layout to the latest typedoc and better lay…
Browse files Browse the repository at this point in the history
…out theme (#212)
  • Loading branch information
shaloo authored Jan 11, 2024
1 parent d769683 commit b40a9e6
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 4 deletions.
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,10 @@
"rollup-plugin-postcss": "^4.0.2",
"rollup-plugin-terser": "^7.0.2",
"ts-jest": "^29.0.3",
"typedoc": "^0.22.15",
"typedoc": "^0.25.7",
"typedoc-plugin-extras": "^2.2.3",
"typedoc-plugin-rename-defaults": "^0.6.6",
"typedoc-theme-hierarchy": "^4.1.1",
"typedoc-plugin-markdown": "^3.12.1",
"typescript": "^4.3.5"
},
Expand All @@ -103,4 +105,4 @@
"*.ts": "eslint --cache --fix",
"*.{js,css,md,ts}": "prettier --write"
}
}
}
74 changes: 74 additions & 0 deletions typedoc-theme/an_style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
@import url('https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@100;200;300;400;500;600;700;800&family=Inter:wght@100;200;300;400&display=block');

:root > * {
font-family: 'Inter';
font-size: 14px;
}

.tsd-page-toolbar {
border: 0;
border-radius: 5px;
}

.tsd-theme-toggle {
padding-top: 0.75rem;
}
.tsd-theme-toggle > h4 {
display: inline;
vertical-align: middle;
margin-right: 0.75rem;
}

.tsd-generator > p {
font-style: italic;
}

pre > button {
position: absolute;
top: 10px;
right: 10px;
opacity: 0;
transition: opacity 0.1s;
box-sizing: border-box;
border: 0;
}

code,
pre {
font-family: Menlo, Monaco, Consolas, 'Courier New', monospace;
padding: 0.4rem;
margin: 0;
font-size: 0.75rem;
border: 0;
border-radius: 0.8em;
}

h1 {
font-size: 1.5rem;
margin: 0.67rem 0;
}

h2 {
font-size: 1.2rem;
margin: 0.83rem 0;
}

h3 {
font-size: 1rem;
margin: 1rem 0;
}

h4 {
font-size: 0.85rem;
margin: 1.33rem 0;
}

h5 {
font-size: 0.8rem;
margin: 1.5rem 0;
}

h6 {
font-size: 0.7rem;
margin: 2.33rem 0;
}
4 changes: 3 additions & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"entryPoints": ["src/index.ts"],
"entryPointStrategy": "expand",
"name": "Auth SDK Reference Guide",
"out": "docs",
"excludePrivate": true,
Expand All @@ -8,5 +9,6 @@
"excludeInternal": true,
"includeVersion": true,
"hideGenerator": true,
"plugin": ["typedoc-plugin-markdown"]
"plugin": ["typedoc-plugin-extras", "typedoc-plugin-rename-defaults", "typedoc-theme-hierarchy"],
"theme": "hierarchy"
}
5 changes: 4 additions & 1 deletion typedochtml.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"entryPoints": ["src/index.ts"],
"entryPointStrategy": "expand",
"name": "Auth SDK Reference Guide",
"out": "htmldocs",
"excludePrivate": true,
Expand All @@ -8,5 +9,7 @@
"includeVersion": true,
"footerDate": true,
"footerTime": true,
"plugin": ["typedoc-plugin-extras"]
"plugin": ["typedoc-plugin-extras", "typedoc-plugin-rename-defaults", "typedoc-theme-hierarchy"],
"theme": "hierarchy",
"customCss": "./typedoc-theme/an_style.css"
}

0 comments on commit b40a9e6

Please sign in to comment.