Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: adds generated reference #2269

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: adds generated reference #2269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ node_modules/
.docusaurus
.DS_Store
build/
.stylelintrc.json
.stylelintrc.json
content/generated-reference
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super neat that we can generate this just for the final build!

10 changes: 9 additions & 1 deletion docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,15 @@ plugins:
],
},
],

[
'docusaurus-plugin-typedoc',
{
id: 'generated-reference',
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
out: "./content/generated-reference",
},
],
],


Expand Down
243 changes: 242 additions & 1 deletion docs/package-lock.json
View file
Open in desktop

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

7 changes: 5 additions & 2 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"css-minimizer-webpack-plugin": "^7.0.0",
"docusaurus-plugin-typedoc": "^1.0.5",
"docusaurus-theme-github-codeblock": "^2.0.2",
"prism-react-renderer": "^2.4.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
"react-dom": "^18.0.0",
"typedoc": "^0.26.7",
"typedoc-plugin-markdown": "^4.2.7"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.5.2",
Expand All @@ -46,4 +49,4 @@
"engines": {
"node": ">=20.0"
}
}
}
Loading