feat(stylebook): add Vue Styleguidist browser-based component stylebook and inline component docs#121
Open
remko48 wants to merge 24 commits intodevelopmentfrom
Open
feat(stylebook): add Vue Styleguidist browser-based component stylebook and inline component docs#121remko48 wants to merge 24 commits intodevelopmentfrom
remko48 wants to merge 24 commits intodevelopmentfrom
Conversation
SudoThijn
requested changes
May 6, 2026
| }, | ||
| { | ||
| test: /\.(js|mjs|cjs)$/, | ||
| exclude: /node_modules\/(?!(@nextcloud|unified|vfile|lowlight|mdast-util|hast-util|unist-util|remark|rehype|micromark|decode-named-character-reference|bail|is-plain-obj|trim|trough|vfile-message|property-information))/, |
Contributor
There was a problem hiding this comment.
I did find one thing that can be fixed
Suggested change
| exclude: /node_modules\/(?!(@nextcloud|unified|vfile|lowlight|mdast-util|hast-util|unist-util|remark|rehype|micromark|decode-named-character-reference|bail|is-plain-obj|trim|trough|vfile-message|property-information))/, | |
| exclude: /node_modules\/(?!(@nextcloud|unified|vfile|lowlight|mdast-util|hast-util|unist-util|remark|rehype|micromark|decode-named-character-reference|bail|is-plain-obj|trim|trough|vfile-message|property-information|vue-codemirror6|codemirror|@codemirror|@lezer|gridstack|axios))/, |
SudoThijn
requested changes
May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
Closes #120
This PR introduces a fully functional browser-based stylebook for the component library using Vue Styleguidist, and adds inline
.mddocumentation to every component directory. It also resolves Vue prop-validation console errors across all component categories that were surfaced by running the styleguide.What changed
Styleguide setup (
styleguide/)styleguide.config.jswith full Vue Styleguidist configuration including aliases, webpack overrides, and global style injectionsetup.jsto register Nextcloud globals, Pinia, Vue Router, and translation stubs before each example renders@nextcloud/l10n,@nextcloud/l10n-gettext, and empty module stubs so examples run without a real Nextcloud backendnextcloud-globals.cssandnextcloud-tokens.cssto simulate Nextcloud's design-token environment inside the styleguidenextcloud-tokens.md— a standalone design-token reference page in the styleguideInline component documentation
ComponentName.mdfiles to every component directory (covers all ~50 components)check-docs.jsto verify coverage for bothdocs/components/*.mdandsrc/components/*/*.mdso CI catches gaps in either locationConsole error fixes
Styling fixes
<main>tag stylingDocumentation and CI
developmentandbetabranches (alongside the existingmainworkflow)documentation.ymlto integrate the styleguide build stepTest plan
cd styleguide && npm install && npm run styleguideand confirm the styleguide opens in the browser with all components listednpm run check:docsfrom the repo root and confirm it exits 0npm testand confirm all existing tests pass