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.
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
bug: typedoc plugins for third party symbols appear to be ignored #263
Comments
Hi there, I can confirm the feature is there, however it's not entirely working well just yet. Running
And when running Strangely enough, the markdown for this code does appear to be valid markdown so my best guess is that Docusaurus is interpreting this markdown in a strange way. Maybe an escape character has to be added somewhere? ### fetchGuildPreview
▸ **fetchGuildPreview**(`guild`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`GuildPreview`](https://discord.js.org/#/docs/main/stable/class/GuildPreview)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `guild` | `GuildResolvable` |
#### Returns
[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`GuildPreview`](https://discord.js.org/#/docs/main/stable/class/GuildPreview)\>
#### Inherited from
Client.fetchGuildPreview
#### Defined in
node_modules/discord.js/typings/index.d.ts:487 Bit annoying that this only shows when building the code so to make testing any potential fixes easier I've created a small repo which has the troublesome markdown files already generated: https://github.com/favna/animated-umbrella The branch I linked in my initial bug report has also been updated with the latest version of the plugin. |
thanks for the report back. that's interesting... i will take a look and report back. |
So this is now appears to be fixed in typedoc-plugin-markdown@3.11.6 The fix was to add a space around the url inside the url parenthesis. ie: |
Wasn't able to re-test this earlier but I can now confirm that this issue is resolved. Thank you for your awesome work! Closing this issue. |
Hello there, I tried adding 2 plugins that offer third part symbols (https://github.com/TypeStrong/typedoc/blob/master/internal-docs/third-party-symbols.md) to my docusaurus generated markdown docs, however, they are simply not made into links. The plugins however work fine when generating typedoc's own HTML.
The typedoc plugins I'm trying to use are: https://github.com/Gerrit0/typedoc-plugin-mdn-links and https://github.com/sapphiredev/typedoc-plugin-djs-links
One of the docusaurus usages of the docusaurus-plugin-typedoc is:
As an example, using this plugin I get the following:
Whereas that same function in the typedoc generated html looks like this:
As you can see, the
Message
symbol is a link here.The matching markdown for the former is:
So the expected result would look like so, note the added link at
Message
:A preview deploy that shows the image above is available on Vercel: https://website-git-feat-add-third-party-symbols-sapphiredev.vercel.app/docs/Documentation/api-framework/namespaces/Resolvers#resolvechannel
It is based on a branch on the repository where I'm using this plugin: https://github.com/sapphiredev/website/tree/feat/add-third-party-symbols (PR for branch: sapphiredev/website#85)
The text was updated successfully, but these errors were encountered: