https://github.com/tobua/exmpl
Quickly create stylish previews for your digital creations
https://github.com/tobua/exmpl
documentation example prototyping stylesheet
Last synced: 11 months ago
JSON representation
Quickly create stylish previews for your digital creations
- Host: GitHub
- URL: https://github.com/tobua/exmpl
- Owner: tobua
- Created: 2018-03-30T11:58:40.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-18T11:21:13.000Z (almost 2 years ago)
- Last Synced: 2025-02-15T15:17:43.598Z (12 months ago)
- Topics: documentation, example, prototyping, stylesheet
- Language: TypeScript
- Homepage: https://tobua.github.io/exmpl
- Size: 2.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
```tsx
import React from 'react'
import { createRoot } from 'react-dom/client'
import { Exmpl, Code } from 'exmpl'
createRoot(document.body).render(
This is the introduction.
Installation & Usage
{`npm i exmpl`}
)
```
`title` can be any React element, npm and github are optional and can be preprended with further icons.
```tsx
Title} icons={Google} npm="exmpl" />
```
## Elements
Includes `Button`, `Input`, `Grid`, `Code` and `Tabs` elements, refer to the [Demo](https://github.com/tobua/exmpl/blob/main/demo/index.tsx) for usage documentation.