shell-driver VS vue-styleguidist

I needed a way to document my shell scripts (or code snippets) and to quickly replace “parameters”. For example, if you want to download a YT video as mp3, you have to remember this command “youtube-dl --extract-audio --audio-format mp3 ” . You can use the autocomplete & history in the terminal but you still have to remember parts of the command and replace the old URL with the new one. You can also save it in a text file, and replace … too many select/replace/copy/paste ops…

A few months ago I made a good enough solution for my problem https://github.com/alexadam/reactive-doc - it saves ~ 10 minutes/day when I have to run complex devops scripts. And I can quickly share the ‘docs’ because they are just plain html files / or markdown.

Now I just finished the next iteration - better ‘syntax’ for input widgets, runnable @shell commands and a web based terminal https://github.com/alexadam/shell-driver with custom filters and selection actions (useful for me)

Next steps: add more features to the web based terminal -> convert history to scripts, autocomplete with parameters, command palette & context aware menus, multiple terminals (with tabs or panels). I also want to add support for React components in the MD editor.

Yeah there’s a recent issue with the main docblock not being detected when using

Unfortunately, I found no way to add JSDoc comments to the counter-update event. I think it is currently not supported in vue-docgen-api, which Storybook uses under the hood to extract code comments into descriptions. Leave a comment if you know a way how to document events in Vue 3.

At my workplace we set up a small component library for stuff that we regularly (re-)use. It has gained quite some traction within our workplace so now we would like to write a proper and easy to use documentation. We would love to use something like vue-styleguidist which relies on jsDoc to generate a website to showcase and develop components.

I found some promising things like Vue Styleguidist (https://vue-styleguidist.github.io/), but unfortunately it only supports Vue 2 by now. My question is: Do you have experience in documenting your Vue 3 SFC? What tools or toolchain do you use?

Most of the frontend stack at Ecosia is built around with Vue. We also had a design style-guide built using Vue Styleguidist. Our style-guide is essentially a list of all the Vue components used across our frontend applications.

Few days ago I worked on a vue-styleguidist project and I had to use a Google Font.