Skip to content

Commit

Permalink
feat: add typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
PascalLuginbuehl committed Aug 24, 2021
1 parent b220b93 commit 0302c21
Show file tree
Hide file tree
Showing 11 changed files with 226 additions and 225 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ node_modules
dist
.vscode
.parcel-cache
/docs/api
1 change: 1 addition & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
slug: /
---

# oidc-client
Expand Down
162 changes: 86 additions & 76 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,80 +3,90 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
title: 'OIDC Client TS',
tagline: 'Dinosaurs are cool',
url: 'https://your-docusaurus-test-site.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: 'facebook', // Usually your GitHub org/user name.
projectName: 'oidc-client-ts', // Usually your repo name.
themeConfig: {
navbar: {
title: 'OIDC Client TS',
logo: {
alt: 'My Site Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Tutorial',
},
{
href: 'https://github.com/pamapa/oidc-client-ts',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/pamapa/oidc-client-ts',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
},
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
path: '../docs',
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl:
'https://github.com/pamapa/oidc-client-ts/edit/master/docs/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],
title: 'OIDC Client TS',
url: 'https://your-docusaurus-test-site.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: 'pamapa', // Usually your GitHub org/user name.
projectName: 'oidc-client-ts', // Usually your repo name.
plugins: [
[
'docusaurus-plugin-typedoc',

// Plugin / TypeDoc options
{
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
docsRoot: "../docs",
disableSources: true,
excludePrivate: true,
readme: "none",
},
],
],
themeConfig: {
navbar: {
title: 'OIDC Client TS',
items: [
{
type: 'doc',
docId: 'api/index',
position: 'left',
label: 'API',
},
{
href: 'https://github.com/pamapa/oidc-client-ts',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/pamapa/oidc-client-ts',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} OIDC Client TS, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
},
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
path: '../docs',
sidebarPath: require.resolve('./sidebars.js'),
routeBasePath: '/',
editUrl:
'https://github.com/pamapa/oidc-client-ts/edit/master/docs/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],
};
132 changes: 132 additions & 0 deletions website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,10 @@
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"docusaurus-plugin-typedoc": "^0.15.3",
"typedoc": "^0.21.5",
"typedoc-plugin-markdown": "^3.10.4"
}
}
Loading

0 comments on commit 0302c21

Please sign in to comment.