vocs

library1.4.1jsnpmunverified

Minimal documentation framework for React projects, powered by Vite. Version 1.4.1 is the latest stable release, with a current release cadence of minor updates every few months. It differentiates from alternatives like Docusaurus or Storybook by being extremely lightweight, offering zero-config setup, and focusing on single-page documentation sites with MDX support. Built on Vite for fast HMR and optimized builds. Ships TypeScript types. Requires React 19 and React DOM 19 as peer dependencies, and Node >=22. Actively maintained by Wevm.

web-framework

npm install vocs

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · VOCS

vocs

web-frameworkjavascriptv1.4.1

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.

defineConfig

✓ import { defineConfig } from 'vocs'

✗ const { defineConfig } = require('vocs')

ESM-only; no CJS support as of v1.

vocs

✓ import vocs from 'vocs'

✗ const vocs = require('vocs')

Default export gives access to the Vite plugin; ESM-only.

type Config

✓ import type { Config } from 'vocs'

✗ import { Config } from 'vocs'

Config is a TypeScript type, not a runtime value. Use 'import type' for correct consumption.

Shows how to scaffold a new Vocs documentation site using create-vocs, then start development, build, and preview.

// Initialize a project (requires Node >=22) npx create-vocs@latest my-docs cd my-docs // Install dependencies npm install // Start development server npm run dev // Build for production npm run build // Preview production build npm run preview

Debug

Known issues

breakingPeer dependency React 19 and React DOM 19 are required. Projects using React 18 will not work.

fix

Upgrade to React 19 or use an older version of Vocs (if available).

affects: >=1.0

gotchaVocs is ESM-only. It does not provide a CommonJS build. Do not use require() to import.

fix

Ensure your project uses ES modules (e.g., type: 'module' in package.json, or use .mjs extension).

affects: >=1.0

gotchaNode.js >=22 is required. Older Node versions will cause errors.

fix

Update Node.js to version 22 or later.

affects: >=1.0

deprecatedThe create-vocs scaffolding tool is the only recommended way to start a project. Manual setup may be unstable.

fix

Use 'npx create-vocs@latest' to initialize a project.

affects: >=1.0

Errors

Common errors & fixes

Error: Cannot find module 'vocs'

Vocs is not installed or using CJS require instead of ESM import.

fix

Run 'npm install vocs' and ensure your project uses ES modules. Use 'import vocs from 'vocs'' instead of require.

Error: React 19 is required. Current version: 18.x

Vocs requires React 19 as a peer dependency.

fix

Upgrade React and React DOM to version 19: 'npm install react@19 react-dom@19'

Error: Unsupported Node.js version. Vocs requires Node >=22

Node.js version is too old.

fix

Install Node.js 22 or later using nvm or your package manager.

Upgrade

Version history

1.4.1latest on npm

Audit

Dependencies

reactrequiredPeer dependency required for rendering documentation components.

react-domrequiredPeer dependency required for DOM rendering.

Agent activity

5 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/wevm/vocs ↗

packagehttps://www.npmjs.com/package/vocs ↗

homepagehttps://vocs.dev ↗