Skip to content
staticview

Installation

Install the core package containing all components and types.

Terminal window
npm install @staticview/ui@beta

AI agents can read the docs as Markdown through llms.txt or llms-full.txt.

Optional Tools

CLI

Install the staticview CLI to add, create, build, and generate documentation for components into your project.

Terminal window
npm install @staticview/cli@beta

See CLI for available commands.

Vite Plugin

If you are authoring components directly in your project, install the Vite plugin to compile and watch .ts web component files.

Terminal window
npm install @staticview/vite-plugin@beta

See Vite Plugin for configuration.

Staticbolt Plugin

If you are authoring components directly in your project, install the Staticbolt plugin to compile and watch .ts web component files.

Terminal window
npm install @staticview/staticbolt-plugin@beta

See Staticbolt Plugin for configuration.

ESLint Plugin

Lint rules for authoring and consuming staticview components.

Terminal window
npm install @staticview/eslint-plugin@beta

See ESLint Plugin for available rules.

Next Steps

  1. Setup to configure TypeScript types for your framework.
  2. After setup, see Theming to style your components.
  3. Setup Editor Support to get rich editor support for your components.