Registry / rollup-documentation

rollup-documentation

library0.0.12jsnpmunverified

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.

npm install rollup-documentation

package ↗

INSTALL

IMPORT

SIG · ROLLUP-DOCUMENTATI

rollup-documentation

javascriptv0.0.12

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import config from 'rollup-documentation'

✗ const config = require('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.

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' }) ] };

Debug

Known issues

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

fix

Migrate to react-styleguidist or Storybook.

affects: >=0.0.0

breakingIncompatible with rollup >=1.0.0. The plugin expects rollup 0.x API.

fix

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

affects: >=1.0.0

gotchaThe 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.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'rollup-documentation'

Package not installed or missing in node_modules.

fix

Run npm install rollup-documentation --save-dev

TypeError: documentation is not a function

Incorrect import style; default export is not a function.

fix

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

Upgrade

Version history

0.0.12latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/rollup-documentation ↗