Skip to content
/ exmpl Public

Quickly create stylish previews for your digital creations

Notifications You must be signed in to change notification settings

tobua/exmpl

Repository files navigation

exmpl

exmpl

Quickly create stylish previews for your digital creations

  • For packages published to npm or on GitHub
  • Quick way to scaffold a preview or demo
  • Button, Input, Grid, Code and Tabs elements

Usage with React

import React from 'react'
import { createRoot } from 'react-dom/client'
import { Exmpl, Code } from 'exmpl'

createRoot(document.body).render(
  <Exmpl title="exmpl Demo" npm="exmpl" github="tobua/exmpl">
    <p>This is the introduction.</p>
    <h2>Installation & Usage</h2>
    <Code>{`npm i exmpl`}</Code>
  </Exmpl>
)

title can be any React element, npm and github are optional and can be preprended with further icons.

<Exmpl title={<h4>Title</h4>} icons={<a href="google.com">Google</a>} npm="exmpl" />

Elements

Includes Button, Input, Grid, Code and Tabs elements, refer to the Demo for usage documentation.