{"id":22962,"library":"vocs","title":"Vocs","description":"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.","status":"active","version":"1.4.1","language":"javascript","source_language":"en","source_url":"https://github.com/wevm/vocs","tags":["javascript","react","static","docs","generator","vite","documentation","mdx","typescript"],"install":[{"cmd":"npm install vocs","lang":"bash","label":"npm"},{"cmd":"yarn add vocs","lang":"bash","label":"yarn"},{"cmd":"pnpm add vocs","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency required for rendering documentation components.","package":"react","optional":false},{"reason":"Peer dependency required for DOM rendering.","package":"react-dom","optional":false}],"imports":[{"note":"ESM-only; no CJS support as of v1.","wrong":"const { defineConfig } = require('vocs')","symbol":"defineConfig","correct":"import { defineConfig } from 'vocs'"},{"note":"Default export gives access to the Vite plugin; ESM-only.","wrong":"const vocs = require('vocs')","symbol":"vocs","correct":"import vocs from 'vocs'"},{"note":"Config is a TypeScript type, not a runtime value. Use 'import type' for correct consumption.","wrong":"import { Config } from 'vocs'","symbol":"type Config","correct":"import type { Config } from 'vocs'"}],"quickstart":{"code":"// Initialize a project (requires Node >=22)\nnpx create-vocs@latest my-docs\ncd my-docs\n\n// Install dependencies\nnpm install\n\n// Start development server\nnpm run dev\n\n// Build for production\nnpm run build\n\n// Preview production build\nnpm run preview","lang":"typescript","description":"Shows how to scaffold a new Vocs documentation site using create-vocs, then start development, build, and preview."},"warnings":[{"fix":"Upgrade to React 19 or use an older version of Vocs (if available).","message":"Peer dependency React 19 and React DOM 19 are required. Projects using React 18 will not work.","severity":"breaking","affected_versions":">=1.0"},{"fix":"Ensure your project uses ES modules (e.g., type: 'module' in package.json, or use .mjs extension).","message":"Vocs is ESM-only. It does not provide a CommonJS build. Do not use require() to import.","severity":"gotcha","affected_versions":">=1.0"},{"fix":"Update Node.js to version 22 or later.","message":"Node.js >=22 is required. Older Node versions will cause errors.","severity":"gotcha","affected_versions":">=1.0"},{"fix":"Use 'npx create-vocs@latest' to initialize a project.","message":"The create-vocs scaffolding tool is the only recommended way to start a project. Manual setup may be unstable.","severity":"deprecated","affected_versions":">=1.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Run 'npm install vocs' and ensure your project uses ES modules. Use 'import vocs from 'vocs'' instead of require.","cause":"Vocs is not installed or using CJS require instead of ESM import.","error":"Error: Cannot find module 'vocs'"},{"fix":"Upgrade React and React DOM to version 19: 'npm install react@19 react-dom@19'","cause":"Vocs requires React 19 as a peer dependency.","error":"Error: React 19 is required. Current version: 18.x"},{"fix":"Install Node.js 22 or later using nvm or your package manager.","cause":"Node.js version is too old.","error":"Error: Unsupported Node.js version. Vocs requires Node >=22"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}