rollup-documentation

0.0.12 verified Mon Apr 27 auth: no javascript deprecated

rollup-documentation (v0.0.12) is a deprecated package providing default react-styleguidist configuration for Yeutech Company Limited. It was part of the rollup-umd ecosystem, designed for generating documentation for UMD modules. The package is no longer actively maintained and has been superseded by other tools. Key differentiators: specific to Yeutech's internal tooling, tightly coupled with rollup-umd v0.8.11. Release cadence: not specified, but appears inactive since around 2018. Alternatives include react-styleguidist directly or modern documentation generators like Storybook.

Common errors

error Error: Cannot find module 'rollup-documentation' ↓

cause Package not installed or missing in node_modules.

fix

Run npm install rollup-documentation --save-dev

error TypeError: documentation is not a function ↓

cause Incorrect import style; default export is not a function.

fix

Use import documentation from 'rollup-documentation' (default import) instead of named import.

Warnings

deprecated rollup-documentation is no longer maintained. Use react-styleguidist directly or modern alternatives like Storybook. ↓

fix Migrate to react-styleguidist or Storybook.

breaking Incompatible with rollup >=1.0.0. The plugin expects rollup 0.x API. ↓

fix Use rollup 0.x or switch to a different documentation plugin.

gotcha The package expects a specific file structure from rollup-umd. Custom setups may break. ↓

fix Ensure your project follows rollup-umd conventions or avoid this package.

Install

npm install rollup-documentation

yarn add rollup-documentation

pnpm add rollup-documentation

Imports

default
wrong
```
const config = require('rollup-documentation')
```
correct
```
import config from 'rollup-documentation'
```
Package primarily exports a default configuration object. ESM import recommended, but CJS require also works.
rollupDocumentation
```
import { rollupDocumentation } from 'rollup-documentation'
```
Named export may exist but is less common. Default import is the standard pattern.
TypeScript types
```
import type { Config } from 'rollup-documentation'
```
Package does not ship TypeScript types. Use @types/rollup-documentation if available, or declare module.

Quickstart

Basic setup using rollup-documentation plugin in a Rollup configuration for generating UMD documentation.

// rollup.config.js
import documentation from 'rollup-documentation';

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/bundle.js',
    format: 'umd',
    name: 'MyLibrary'
  },
  plugins: [
    documentation({
      // Configuration options
      title: 'My Library Documentation',
      components: 'src/**/*.js'
    })
  ]
};