vue-slides

Table of Contents

• Install
• Usage
• Command-Line Tool
• Contributing
• Development
• License

Install

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

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

// 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:

// app.js
import {
  Presentation,
  Slide,
  Title,
  SubTitle
} from 'vue-slides'

export default {
  name: 'my-presentation',
  render(h) {
    return (
      <Presentation>
        <Slide>
          <Title>My Superb Presentation</Title>
          <SubTitle>such slides, very neat!</SubTitle>
        </Slide>
      </Presentation>
    )
  }
}

Render the slides in browser:

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

# to run the example
$ npm i -g vbuild
$ npm run dev

# test
$ npm test

License

MIT © EGOIST