https://github.com/egoist/vue-slides

[under development] Fantastic slides made with Vue.js
https://github.com/egoist/vue-slides

Last synced: 22 days ago
JSON representation

[under development] Fantastic slides made with Vue.js

• Host: GitHub
• URL: https://github.com/egoist/vue-slides
• Owner: egoist
• License: mit
• Created: 2016-09-18T06:27:15.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-12-25T13:53:10.000Z (almost 3 years ago)
• Last Synced: 2024-10-04T13:31:20.943Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://vs.surge.sh/
• Size: 11.7 KB
• Stars: 19
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-slides

[![NPM version](https://img.shields.io/npm/v/vue-slides.svg?style=flat-square)](https://npmjs.com/package/vue-slides) [![NPM downloads](https://img.shields.io/npm/dm/vue-slides.svg?style=flat-square)](https://npmjs.com/package/vue-slides) [![Build Status](https://img.shields.io/circleci/project/egoist/vue-slides/master.svg?style=flat-square)](https://circleci.com/gh/egoist/vue-slides)

Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Command-Line Tool](#command-line-tool)

- [Contributing](#contributing)

- [Development](#development)

- [License](#license)

## Install

This project is **under heavily development**, for a quick preview you can visit: http://vs.surge.sh

```bash

# vue-slides needs vue and vuex

$ npm install --save vue vuex

$ npm install --save vue-slides

```

## Usage

Vue-Slides use Vuex to manage states, so you should bind the `slides module` to your existing vuex store before getting started.

```js

// in your store.js

import Vue from 'vue'

import Vuex from 'vuex'

import {registerSlidesModule} from 'vue-slides'

Vue.use(Vuex)

const store = new Vuex.Store()

registerSlidesModule(store)

export default store

```

Then write the actual slides:

```js

// app.js

import {

  Presentation,

  Slide,

  Title,

  SubTitle

} from 'vue-slides'

export default {

  name: 'my-presentation',

  render(h) {

    return (

      

        

          My Superb Presentation

          such slides, very neat!

        

      

    )

  }

}

```

Render the slides in browser:

```js

import App from './app'

new Vue({

  el: '#app'

  render: h => h(App)

})

```

## Command-Line Tool

You can write JSX or HTML or even Markdown to generate beautiful slides, coming soon...

## Contributing

Check out [these issues](https://github.com/egoist/vue-slides/labels/contribution%20welcome) to get started fast!

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Development

```bash

# to run the example

$ npm i -g vbuild

$ npm run dev

# test

$ npm test

```

## License

[MIT](https://egoist.mit-license.org/) © [EGOIST](https://github.com/egoist)