typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
691 stars 171 forks source link

vitepress example broken when cloned locally #643

Closed bukowa closed 1 week ago

bukowa commented 1 week ago

What package is the bug related to?

typedoc-vitepress-theme

Describe the issue

I followed https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/integrations/vitepress

  1. First I had to change dir in typedoc.json to properly resolve:

    "entryPoints": ["../../dummy-api/src/*"],
  2. npm run docs:dev

  3. Visit website and try clicking "Next Page" you will realize you are going back.

TypeDoc configuration

{
  "entryPoints": ["../../dummy-api/src/*"],
  "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
  "githubPages": false,
  "readme": "none",
  "indexFormat": "table",
  "useCodeBlocks": true,
  "disableSources": true,
  "textContentMappings": {
    "title.indexPage": "API Reference",
    "title.memberPage": "{name}"
  }
}

Expected behavior

No response

tgreyuk commented 1 week ago

Sorry I can't replicate. Next page link is working correctly here? https://typedoc-vitepress-theme-example-docs-rf58bio35.vercel.app/api/

bukowa commented 1 week ago

Sorry I can't replicate. Next page link is working correctly here? https://typedoc-vitepress-theme-example-docs-rf58bio35.vercel.app/api/

Team Access Required

bukowa commented 1 week ago

Tried on second PC and 4 browsers with fresh project. When you navigate Next Page several times you will realize it's broken as you go back to the root Api.

tgreyuk commented 1 week ago

Ok should be fixed now in typedoc-vitepress-theme@1.01 (there was some bad paths in sidebar file).

bukowa commented 1 week ago

Thanks ill check this later

bukowa commented 1 week ago

Working on my end with new example ^^