Comments (13)
@CobyPear Thanks for your repro, super helpful and really appreciated 🙌 The issue was easy to spot thanks to the minimal amount of code and your detailed instructions.
You noted 2 issues:
-
"The link in ClassA to ClassAOptions interface does not work"
This one should be fixed in the version
0.11.1
that I just released. On top of having a new test for this specific case, I also manually tested this new version locally on your repro and the link works as expected. -
"The links in ClassB to PackageA are not rendering as links"
I tested this exact scenario in your reproduction using only TypeDoc with the exact same configuration used in the repro and the generated output contains the same issue. Here is a screenshot of the generated pages by TypeDoc for
ClassA
(left) which includes all expected links andClassB
(right) whereClassA
andClassAOptions
are not links.In this case, not much can be done at the plugin level to fix this issue.
from starlight-typedoc.
Thanks for the report.
Would you be able to setup and share a small repository with the example code you shared above leading to that issue?
Having just that exact same code you shared in my case does not generate any invalid links.
repro.mp4
from starlight-typedoc.
All right. Here you have. https://github.com/PabloRNC/twitchapi-docs.
The code is a bit messy.
from starlight-typedoc.
You can see my vercel deploy https://twitchapi-docs.vercel.app/api/chatbot/classes/banmanager/ to test.
from starlight-typedoc.
All right. Here you have. PabloRNC/twitchapi-docs.
The code is a bit messy.
Yeah, this is why I would prefer a minimal reproduction with the exact same code you shared in your first message as setting up and figuring out the entire code base, finding where the issue even is, etc. will take a lot of time.
from starlight-typedoc.
Yeah. I didn't send it as it was a little bit messy but if you need it.
from starlight-typedoc.
Have you been able to reproduce the bug?
from starlight-typedoc.
No, I was waiting for a simple repro involving only the code from the original post of the issue. The one you sent contains submodules to an entire code base so I assumed this was definitely not it?
from starlight-typedoc.
The original code from the issue was a simple example about what I was facing. The real code is in that repo and involves all the link tags.
from starlight-typedoc.
Hi @HiDeoo. I reported this same (or very similar) issue at #32. I had some time to make a minimal reproduction: https://github.com/CobyPear/starlight-typedoc-broken-links
Let me know if you need any more information. Thanks!
from starlight-typedoc.
Thanks much for the quick release!
from starlight-typedoc.
Thanks for the fix.
from starlight-typedoc.
In my case it didn't fix the broken link. It still the same. I have updated to the latest version.
from starlight-typedoc.
Related Issues (20)
- Broken links when `base` is set in the astro config HOT 1
- Subfolders in Sidebar
- incompatible with entryPointStrategy "packages"? HOT 6
- typeDoc option ignored in packages mode HOT 1
- empty groups still happen HOT 1
- latest typedoc-plugin-markdown not working HOT 1
- Support for multiple typedoc instance per starlight HOT 2
- `{@link}` tags generate broken links HOT 4
- External source links not working HOT 10
- Generated links not working. HOT 7
- Broken Links HOT 12
- Groups related configuration HOT 4
- bug: errors when using this on typedoc-plugin-markdown >= v4.0.0-next.58
- Badge Support HOT 1
- API Links Different Across Platforms HOT 2
- Links generation for subfolders are broken HOT 1
- request: possibility to customize frontmatter for pages and readme (individually) HOT 1
- Custom frontmatter cannot be added via TypeDoc plugin HOT 13
- bug: descriptions are being dropped for "other" category symbols HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from starlight-typedoc.