Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 4.08 KB

README.md

File metadata and controls

86 lines (59 loc) · 4.08 KB

<api-viewer>

API documentation and live playground for Web Components. Based on custom elements manifest JSON format.

<api-viewer src="./custom-elements.json"></api-viewer>

Documentation →

Live Demo →

Screenshot of api-viewer docs

Screenshot of api-viewer demo

Features

Install

npm install api-viewer-element

Check out the Getting Started guide.

Usage

The following web components are available:

Contributing

Install dependencies

yarn

Run demo in browser

yarn dev

Open http://127.0.0.1:8000

Run the docs locally

yarn start

Open http://127.0.0.1:8000

Build the docs site

yarn dist

Acknowledgements