Package Exports

@vltansky/generate-wds-docs
@vltansky/generate-wds-docs/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vltansky/generate-wds-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@vltansky/generate-wds-docs

A CLI tool to generate documentation for Wix Design System components by fetching data from the Wix Style React API.

Installation

npm install -g @vltansky/generate-wds-docs

Usage

generate-wds-docs [options]

Options

-o, --output <dir> - Output directory path (default: "./docs")

Example

# Using default options
generate-wds-docs

# Specifying custom output directory
generate-wds-docs -o ./my-docs

Output

The tool will:

Fetch component data from the Wix Style React API
Generate a README.md file with the table of contents
Create individual markdown files for each component
All files will be created in the specified output directory

Generated Documentation Structure

Each component documentation includes:

Description
Demo examples
Developer examples
Feature examples
Common use cases
Do's and Don'ts