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

toc page mentions anchor config in passing but not explicitly #255

Open
newtmitch opened this issue Dec 10, 2023 · 2 comments
Open

toc page mentions anchor config in passing but not explicitly #255

newtmitch opened this issue Dec 10, 2023 · 2 comments
Assignees
Milestone

Comments

@newtmitch
Copy link

Looks like the use:toc param allows for an anchor: boolean setting as part of its configuration to not include an anchor tag as part of the output. You mention it in passing under the data-tag-anchor toc attributes at the bottom, but nowhere else (that I could see) that it's an option you can pass in for the anchor tag not to be generated at all. It might be good to include that explicitly as an option the user can pass in to suppress the anchor tag generation in the final output.

Sorry if I missed it, though. I looked several times. :)

@vnphanquang
Copy link
Owner

@newtmitch thanks for the suggestion. Apologies for not explicitly including that in the doc page. The toc param interface overall is pretty hefty, however; see here for full API. So when writing the doc I was conflicted with whether to be comprehensive or just keep it minimal and link to the raw API. But perhaps there is no reason not to do both :)

I'm currently focusing on organizing a Svelte meetup here in Vietnam so will come back here as soon as I can. In the meantime, happy December and (upcoming) holidays!

@vnphanquang vnphanquang self-assigned this Dec 11, 2023
@vnphanquang vnphanquang added this to the Anytime milestone Dec 11, 2023
@newtmitch
Copy link
Author

Thanks for the update! I ended up going to that source file, or another one like it, to find the param was actually available. I think even a link to that file as the API for the toc component would be a good addition vs. me (and others) rooting around through the source to find the right source file describing the API. I agree with you, though, outlining that entire API might be a bit onerous.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

2 participants