Comments (6)
Thanks a lot, that was super helpful 🙌
The sidebar is now properly generating with the new changes:
Also, if you want to push your code somewhere, I can try it myself.
Sure, I've pushed a draft PR in #24
from starlight-typedoc.
tangentially related: it's unclear how my existing typedoc config files affect the behavior of this plugin. I can confirm they are being read.
from starlight-typedoc.
Finally got the time to start working on this. The changes require a bit of refactoring to get the proper fixtures in place for this setup but I've managed to reproduce the issue and I seem to have a working prototype adding support for this.
With the following project structure:
project
├── package.json
├── packages
│ ├── bar
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── ...
│ │ │ └── ...
│ │ ├── tsconfig.json
│ │ └── typedoc.json
│ └── foo
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── ...
│ │ │ └── ...
│ │ ├── tsconfig.json
│ │ └── typedoc.json
├── tsconfig.base.json
└── tsconfig.json
And a plugin configuration like this:
{
"entryPoints": ["../fixtures/project/packages/*"],
"tsconfig": "../fixtures/project/tsconfig.json",
"typeDoc": {
"entryPointStrategy": "packages"
}
}
I would now get the proper sidebar generated and all links working as expected.
This still requires a bit of work (mostly adding new tests for this), but before going further, as this is not a setup I use myself, I was wondering if your project was available somewhere publicly so I could test this on a real world example?
from starlight-typedoc.
I'll make a branch for you.
from starlight-typedoc.
OK, see this PR.
Also, if you want to push your code somewhere, I can try it myself.
from starlight-typedoc.
Fixed with #24 that should be released relatively soon.
from starlight-typedoc.
Related Issues (10)
- hideKindPrefix will be removed from typedoc-plugin-markdown HOT 3
- `@link` not using `relativeURL` override HOT 1
- Typedoc 0.25 breaks build HOT 1
- Broken links when `base` is set in the astro config HOT 1
- Subfolders in Sidebar
- typeDoc option ignored in packages mode HOT 1
- empty groups still happen HOT 1
- latest typedoc-plugin-markdown not working HOT 1
- Extend typeDoc config type HOT 2
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.