https://github.com/potato4d/kamishibai-viewer

Qiita slide mode embed library
https://github.com/potato4d/kamishibai-viewer

library vue vue-cli-3 web-component web-components webcomponent

Last synced: 2 days ago
JSON representation

Qiita slide mode embed library

• Host: GitHub
• URL: https://github.com/potato4d/kamishibai-viewer
• Owner: potato4d
• License: mit
• Archived: true
• Created: 2018-12-22T12:15:02.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-24T00:37:07.000Z (over 5 years ago)
• Last Synced: 2024-09-21T02:31:54.354Z (6 days ago)
• Topics: library, vue, vue-cli-3, web-component, web-components, webcomponent
• Language: Vue
• Homepage: https://potato4d.github.io/kamishibai-viewer/
• Size: 2.77 MB
• Stars: 19
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kamishibai Viewer

[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/potato4d/kamishibai-viewer)

Web Component based Qiita slide viewer built with Vue.js(Vue CLI v3)

[![Image from Gyazo](https://i.gyazo.com/447d26f36fd0d346464be0901ee51ddc.gif)](https://gyazo.com/447d26f36fd0d346464be0901ee51ddc)

## !! 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!

1. Load runtime on script tag

```

```

2. Write custom element tag for your HTML

```html

```

3. 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

```bash

$ git clone https://github.com/potato4d/kamishibai-viewer

$ cd kamishibai-viewer

```

### Install deps

```bash

$ yarn

```

### Run development server

```bash

$ yarn serve

```

### Build

```bash

$ yarn build:web # Build Development website

$ yarn build # Build Web Component

```

## LICENSE

MIT @ HANATANI Takuma(@potato4d)

email: [email protected]