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

Add API to add page headings from within Vue components #2002

Open
ptandler opened this issue Nov 6, 2019 · 3 comments
Open

Add API to add page headings from within Vue components #2002

ptandler opened this issue Nov 6, 2019 · 3 comments
Labels
status: core team review Priority issues for the core team to review

Comments

@ptandler
Copy link

ptandler commented Nov 6, 2019

Feature request

What problem does this feature solve?

Currently, it is not possible to add headings that show up in TOC or sidebar from within Vue component templates.

An API to add page headings would allow components to make use of the sidebar="auto" feature.

(See related issue #1423 or https://stackoverflow.com/questions/55328002/how-to-generate-headings-from-within-vue-components-in-vuepress)

What does the proposed API look like?

I'm not that familiar with the VuePress architecture that I dare to propose an API.

How should this be implemented in your opinion?

Is there anything that is executed for components during build time?

Are you willing to work on this yourself?

If I get some help in designing such an API, I am willing.

@larionov
Copy link
Contributor

We would like to have such API too
@ulivz can we have some reply from core team if this feature will be considered so we can decide if we can try working on it?

@fmonper1
Copy link

This would be a perfect feature when rendering sections from a JSON file. If theres anything I can do to help Ill do so willingfully!

@staghouse
Copy link

Any update on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: core team review Priority issues for the core team to review
Projects
None yet
Development

No branches or pull requests

5 participants