vue-styleguidist
JSDoc
vue-styleguidist | JSDoc | |
---|---|---|
6 | 68 | |
2,444 | 14,767 | |
0.6% | 0.6% | |
8.2 | 9.3 | |
13 days ago | 6 days ago | |
TypeScript | JavaScript | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
vue-styleguidist
-
Vue 3 comp api autogenerated component docs
Yeah there’s a recent issue with the main docblock not being detected when using
-
Document & Test Vue 3 Components With Storybook
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.
-
How do you properly document properties with type object/array?
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.
-
Documentation Tools for Vue 3 (with TypeScript)
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?
-
Writing Vue Storybook stories in markdown
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.
-
How to add Google Fonts in Vue Styleguidist
Few days ago I worked on a vue-styleguidist project and I had to use a Google Font.
JSDoc
-
Figma's Journey to TypeScript
You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead.
It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are.
Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript.
[1] https://jsdoc.app/
-
Eloquent JavaScript 4th edition (2024)
I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.
[1] https://jsdoc.app/
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
This is where JSDoc comes to save the day.
-
Add typing to your Javascript code (without Typescript, kinda) ✍🏼
The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:
-
What is JSDoc and why you may not need typescript for your next project?
There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app
-
TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc
JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools.
-
Adding a search feature to my app
Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and also does not cover many hidden use cases. It provides less than the bare minimum for what it needs to do - a lot of the time I am forced to rely on external user documentation elsewhere to use JSDoc effectively. That was why I was drawn to the search field in particular in Docusaurus.
-
JavaScript First, Then TypeScript
The Svelte team followed suit but motivated by the maintainer's developer experience as they migrated the project away from TypeScript in favor of plain JSDoc comments for type annotations instead.
-
No comments. Now what?
Even more relevant, tools like Javadoc, JSDoc, Doxygen, etc. read comments in a specific format to generate documentation. These comments do not affect readability. On the contrary, Javadocs are great for explaining how to use these entities. Combined with tools like my dear Doctest, we even get guarantees of accuracy and correctness!
-
The Complete 2023 Guide to Learning TypeScript - From Beginner to Advanced
Document types with JSDoc annotations
What are some alternatives?
vite - Next generation frontend tooling. It's fast!
ESDoc - ESDoc - Good Documentation for JavaScript
vue-3-storybook-demo - Created with StackBlitz ⚡️
documentation.js - :book: documentation for modern JavaScript
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
Docusaurus - Easy to maintain open source documentation websites.
vuetify - 🐉 Vue Component Framework
apiDoc - RESTful web API Documentation Generator.
vue-storybook-example - Storybook DS using Vue and MDX
YUIDoc - YUI Javascript Documentation Tool
react-styleguidist - Isolated React component development environment with a living style guide