Demoboard
Table of Contents
Install
yarn add demoboard
Basic Usage
// A component that you want to demonstrate // Create a demoboard instanceconst demoboard = // Add a section to demonstrate the `Button` componentdemoboard // Mount the demoboard to given selector
Guide
React Components
It just works™.
Vue Components
Just convert your Vue component into React component with @egoist/vue-to-react:
demoboard demoboard
Customize Homepage
const demoboard = const readme = `<h1>Hello</h1>`// Or// const readme = () => <h1>Hello</h1>
readme
should be a Markdown string.
Customize Site Title
const demoboard =
Then title
defaults to Demoboard
.
Display Source Code
demoboard
Display README for Each Demo
demoboard
readme
should be a Markdown string.
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
demoboard © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).
github.com/egoist · GitHub @EGOIST · Twitter @_egoistlily