kamishibai-viewer
v1.0.6
Published
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/potato4d/kamishibai-viewer)
Downloads
16
Readme
Kamishibai Viewer
Web Component based Qiita slide viewer built with Vue.js(Vue CLI v3)
!! Under development !!
Kamishibai is a under development library. Because breaking changes may be born, please be careful when using.
About
This is a library for embedding slides of Qiita which is a Japanese technical document sharing site.
demo: https://potato4d.github.io/kamishibai-viewer/dist/1.0.0/demo.html
Usage
※ As we are planning to publish to webcomponents.org, the URL may change!
- Load runtime on script tag
<script src="https://unpkg.com/vue"></script>
<script src="https://potato4d.github.io/kamishibai/dist/1.0.0/kamishibai.min.js"></script>
- Write custom element tag for your HTML
<kamishibai-viewer itemid="4ff5873776992f0511d6"></kamishibai-viewer>
- Done!
Props
- itemid: String
- Qiita item ID
- apikey?: String
- Qiita personal access token
Contributing
requirements:
- Node: Current LTS
- Yarn: 1.12.0 or higher
clone repository
$ git clone https://github.com/potato4d/kamishibai-viewer
$ cd kamishibai-viewer
Install deps
$ yarn
Run development server
$ yarn serve
Build
$ yarn build:web # Build Development website
$ yarn build # Build Web Component
LICENSE
MIT @ HANATANI Takuma(@potato4d)
email: [email protected]