Skip to content

Comments

Typedoc#4005

Closed
benmccann wants to merge 2 commits intomasterfrom
typedoc-json
Closed

Typedoc#4005
benmccann wants to merge 2 commits intomasterfrom
typedoc-json

Conversation

@benmccann
Copy link
Member

@benmccann benmccann commented Feb 19, 2022

Closes #3996

Preview: https://kit-svelte-dev-l413933f6-svelte.vercel.app/types

Things left to do:

  • currently displaying only property names. need to display the types and jsdoc comments as well. it's a little tricky because the types can be complex. probably need a shared fragment or component to do this
  • it would be nice to link to types that are from SvelteKit. maybe link to MDN as well. need to search through the json file to find which exist
  • shouldn't check in the .json file. generate it at build time and .gitignore it
  • there's a few things like type aliases, the location of the source file, etc. that i'm currently not displaying. we probably don't need to display a lot of these, but there might be a couple we'd want to add
  • the docs don't link to this new page at all. perhaps it shouldn't even be a new page and should just be on the TypeScript page or something. I haven't thought about this yet
  • the styles need to be cleaned up. I copied them from the faq page as a start, but there's probably a lot that can be removed or written without global
  • typedoc is generating a good handful of errors when running it

@changeset-bot
Copy link

changeset-bot bot commented Feb 19, 2022

⚠️ No Changeset found

Latest commit: 5de4826

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@benmccann
Copy link
Member Author

Closing in favor of #4011

@benmccann benmccann closed this Feb 20, 2022
@benmccann benmccann deleted the typedoc-json branch February 20, 2022 03:58
@benmccann benmccann mentioned this pull request Mar 24, 2022
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generated TypeDoc

1 participant