Closed elringus closed 10 months ago
Hello and thank you for such a clear description and associated repo.
If you update to 1.0.0-next.6
these issues should be fixed.
I also noticed that you were attempting to tweak a few bits to the output that can actually be accomplished with existing TypeDoc options.
.nojekyll
file.none
makes the index.md
page the docs index page.In addition I have added an additional collapsed
option to the VitePress sidebar object.
This is what my new api.sh
looks like with v1.0.0-next.6
:
echo '{
"entryPoints": [
"../src/server/index.ts",
"../src/plugin/youtube/index.ts",
"../src/plugin/svg.ts",
"../src/plugin/astro.ts",
"../src/plugin/vite.ts"
],
"tsconfig": "../src/tsconfig.json",
"hideBreadcrumbs": true,
"useCodeBlocks": true,
"out": "api",
"textContentMappings": {
"title.indexPage": "API Reference",
"title.memberPage": "{name}",
},
"plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
"githubPages": false,
"readme": "none",
"hideGenerator": true,
"sidebar": {
"collapsed": false
}
}' > typedoc.json
typedoc
Thank you so much for the fast fix and the example! It's now all working perfectly. I've actually hacked the sidebar collapse because it used to show expand icons next to items that couldn't be expanded, but it seems to be fixed now as well. The plugin is brilliant, thanks again!
Description
When
useCodeBlocks
is enabled, some pages are not generated causing dead links. Whentypedoc-plugin-markdown
is not used, the pages are generated, so it doesn't seem to be a typedoc issue.Tested
typedoc-plugin-markdown
version:4.0.0-next.39
.Repro
cd docs
npm i
npm run docs:api
docs/api/plugin/astro/type-aliases/AstroIntegration.md
file is generateduseCodeBlocks
totrue
indocs/scripts/api.sh
npm run docs:api
docs/api/plugin/astro/type-aliases/AstroIntegration.md
is missingExpected
docs/api/plugin/astro/type-aliases/AstroIntegration.md
is generated whenuseCodeBlocks
is enabledNote
AstroIntegration
is not the only file that is missing, runnpm run docs:build
for the full list.