Skip to content
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

An option to treat sidebar link as external #210

Open
mutantcornholio opened this issue Sep 20, 2024 · 0 comments
Open

An option to treat sidebar link as external #210

mutantcornholio opened this issue Sep 20, 2024 · 0 comments

Comments

@mutantcornholio
Copy link

I'd like to have a following setup: some docs are generated by vocs, but some paths are separate html roots

Kinda like this:

/index.html -- from vocs
/getting-started/index.html -- also from vocs
/typedoc/index.html -- generated by typedoc

To achieve that, i generate both types of docs, and copy them in the same root.

Now, I want to add a link to typedoc docs in the sidebar:

{
  sidebar: [
    {
      text: "Getting Started",
      link: "/getting-started",
    },
    {
      text: "Typedoc Docs",
      link: "/typedoc/",
    },
  ]
}

to config, the link will be handled by react-router and produce 404 on click (reloading page will take me to typedoc docs)

Same would happen if I use absolute link with hostname, but the hostname would be the same.

Maybe adding something like this would make sense?

{
  text: "Typedoc Docs",
  link: "/typedoc/",
  extenal: true,
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant