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

namedAnchors not having any effect, bitbucket compatibility #277

Closed
anantoghosh opened this issue Dec 23, 2021 · 2 comments
Closed

namedAnchors not having any effect, bitbucket compatibility #277

anantoghosh opened this issue Dec 23, 2021 · 2 comments

Comments

@anantoghosh
Copy link

Hi @tgreyuk,

I'm trying to use typedoc-plugin-markdown to generate markdown doc for bitbucket cloud.

The anchors in the TOC do not work in bitbucket.

I tried using --namedAnchors but it does not seem to have any effect on the generated docs.

I've added the repo for you to check out, docs folder has the regular output and named-docs has the output with --namedAnchors
I've also added the same repo to bitbucket.

and thank you for your work in this project.

@tgreyuk
Copy link
Member

tgreyuk commented Dec 23, 2021

Hi @anantoghosh .. thanks that option seems to have gotten removed in a previous refactor. But actually I don't think that will help you because (the last time i looked) bitbucket cloud escapes html. I did create another package to fix bitbucket cloud anchor headers which i think should help you. https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-bitbucket-theme

@anantoghosh
Copy link
Author

Hi thank you @tgreyuk , I'll try typedoc-bitbucket-theme. I had seen that package name, but I thought it was related to html docs theming 🤦‍♂️ .

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

2 participants