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 documentation setup with automated building and publishing to github pages #27

Open
jsheunis opened this issue Jun 19, 2024 · 3 comments

Comments

@jsheunis
Copy link
Collaborator

Look into JSdoc; 863e84c already has a single example of a jsdoc-based docstring for a module.

For an html theme, investigate:

@jsheunis
Copy link
Collaborator Author

jsheunis commented Sep 5, 2024

JSDoc can be used for api documentation.

For general user and developer documentation, I have decided to go with Vitepress, since it's compatible with vuejs 3 and powered by vite tooling which is already used for the build process of this package.

@jsheunis
Copy link
Collaborator Author

jsheunis commented Sep 5, 2024

With f432d21 to df848e2 we now have a setup for docs that are deployed together with the demo shacl-vue application (at /docs) via github pages.

@jsheunis
Copy link
Collaborator Author

jsheunis commented Sep 9, 2024

The only step left to figure out is how to use jdoc for api doc generation and then make the resulting pages part of the docs generated by vitepress

Could aim to get a script that runs through vue components, generates markdown from their jsdoc-style comments and docstrings, and then adds those markdown files to the sources for vitepress to build the docs site from.

Look into:

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

1 participant