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

Support for JavaScript files like store modules? #164

Open
jualoppaz opened this issue Jun 16, 2020 · 2 comments
Open

Support for JavaScript files like store modules? #164

jualoppaz opened this issue Jun 16, 2020 · 2 comments
Labels
help wanted Extra attention is needed tricky

Comments

@jualoppaz
Copy link

Hi!

I am using vuese at first time and I can see that is a very good solution for generate docs about vue components. However I can't see any mechanism for doc any other javascript utilities like vuex store modules.

Is there any way of doing this now? Or is this feature planned for be developed in the future?

Thanks.

@IWANABETHATGUY IWANABETHATGUY added the help wanted Extra attention is needed label Jun 18, 2020
@johnsusek
Copy link

A good way of going about this might be to use existing solutions like JSDoc for plain .js files.

This could generate .md files in a folder alongside components/, and index.html (docute) could be configured somehow to build sidebar from both or these. Maybe a feature to "merge" sidebar definitions into existing docute config. So you could have both JSDoc and Vuese working together. Vuese might need a new config option like "external markdown folders" which it could build the sidebar from.

@johnsusek
Copy link

PR #190, combined with a module like https://github.com/jsdoc2md/jsdoc-to-markdown could make something like this possible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed tricky
Projects
None yet
Development

No branches or pull requests

3 participants