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

Markdown path is not match origin URL #262

Closed
cary-hu opened this issue Nov 5, 2021 · 3 comments
Closed

Markdown path is not match origin URL #262

cary-hu opened this issue Nov 5, 2021 · 3 comments
Labels
documentation Requires examples / documentation

Comments

@cary-hu
Copy link

cary-hu commented Nov 5, 2021

We want to render a side bar toc, but I got the url from project declaration, it's not match rendered markdown path:
image
image

How can I got the right URL in the project declaration?

@tgreyuk
Copy link
Member

tgreyuk commented Nov 27, 2021

Not entirely sure what I am looking at here. (sorry) In what context are you trying to create a sidebar?

@cary-hu
Copy link
Author

cary-hu commented Nov 29, 2021

In our case, we will use typedoc-plugin-markdown to generate our product API doc to markdown,

and then,

we will serve those markdown in our site, and for more comfortable experience, we will generate Table of Content in Sidebar but not inline TOC.

seems like :

image

But I have no idea to get all the correctly path for each markdown.

If not the case for this plugin, sorry for disturbing

@tgreyuk tgreyuk added the documentation Requires examples / documentation label May 13, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

typedoc-plugin-markdown@4.0.0

https://www.typedoc-plugin-markdown.org/docs/navigation

@tgreyuk tgreyuk closed this as completed May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Requires examples / documentation
Projects
None yet
Development

No branches or pull requests

2 participants