<commit_before>= bespoke-onstage
<NAME> <https://github.com/mojavelinux>
// Settings:
:idprefix:
:idseparator: -
:experimental:
//ifdef::env-github[:badges:]
// URIs:
:uri-raw-file-base: https://raw.githubusercontent.com/opendevise/bespoke-onstage/master

ifdef::badges[]
image:https://img.shields.io/npm/v/bespoke-onstage.svg[npm package, link=https://www.npmjs.com/package/bespoke-onstage]
image:https://img.shields.io/travis/opendevise/bespoke-onstage/master.svg[Build Status (Travis CI), link=https://travis-ci.org/opendevise/bespoke-onstage]
endif::[]

An adapter for using the onstage shell (i.e., presenter mode) from http://paulrouget.com/dzslides[DZSlides] to drive a http://markdalgleish.com/projects/bespoke.js[Bespoke.js] presentation.

image::demo/screenshot.jpg[Screenshot]

NOTE: A modified version of the onstage.html file from DZSlides is included in this plugin, but this plugin also works if you use the original file from DZSlides.

////
== Example

//http://opendevise.github.io/bespoke-onstage[View the demo] online.

This repository includes a demo folder the shows this plugin in action.
To view it locally, you first need to clone this repository:

 $ git clone https://github.com/opendevise/bespoke-onstage && cd bespoke-onstage

Next, install the dependencies inside the project folder using npm:

 $ npm install

Finally, visit the file [path]_demo/index.html_ in your browser to see the plugin in action.
////

== Download

Download the {uri-raw-file-base}/dist/bespoke-onstage.min.js[production mode version] or the {uri-raw-file-base}/dist/bespoke-onstage.js[development mode version], or use a <<package-managers,package manager>>.

== Usage

This plugin is shipped in a https://github.com/umdjs/umd[UMD format], meaning it is available as a CommonJS/AMD module or as a browser global.

For example, when using CommonJS modules:

```js
var bespoke = require('bespoke'),
  onstage = require('bespoke-onstage');

bespoke.from('.deck', [
  onstage()
]);
```

When using a browser global:

```js
bespoke.from('.deck', [
  bespoke.plugins.onstage()
]);
```

Once the onstage plugin is added, open the file [path]_node_modules/bespoke-onstage/demo/onstage.html_ and enter the absolute URL to your presentation.
You will see a presenter console that you can use to drive the presentation in another browser window.

Launch the presentation window by clicking on btn:[Launch].

== Package managers

=== npm

```bash
$ npm install bespoke-onstage
```

=== Bower

```bash
$ bower install bespoke-onstage
```

== Credits

This plugin was built with https://github.com/markdalgleish/generator-bespokeplugin[generator-bespokeplugin].

== License

http://en.wikipedia.org/wiki/MIT_License[MIT License]<commit_msg>reorg README<commit_after>= bespoke-onstage
<NAME> <https://github.com/mojavelinux>
// Settings:
:idprefix:
:idseparator: -
:experimental:
//ifdef::env-github[:badges:]
// URIs:
:uri-raw-file-base: https://raw.githubusercontent.com/opendevise/bespoke-onstage/master

ifdef::badges[]
image:https://img.shields.io/npm/v/bespoke-onstage.svg[npm package, link=https://www.npmjs.com/package/bespoke-onstage]
image:https://img.shields.io/travis/opendevise/bespoke-onstage/master.svg[Build Status (Travis CI), link=https://travis-ci.org/opendevise/bespoke-onstage]
endif::[]

An adapter for using the onstage shell (aka presenter mode) from http://paulrouget.com/dzslides[DZSlides] to drive a http://markdalgleish.com/projects/bespoke.js[Bespoke.js] presentation.

image::demo/screenshot.jpg[Screenshot]

NOTE: A modified version of the onstage.html file from DZSlides is included in this plugin, but this plugin also works if you use the original file from DZSlides.

////
== Example

//http://opendevise.github.io/bespoke-onstage[View the demo] online.

This repository includes a demo folder the shows this plugin in action.
To view it locally, you first need to clone this repository:

 $ git clone https://github.com/opendevise/bespoke-onstage && cd bespoke-onstage

Next, install the dependencies inside the project folder using npm:

 $ npm install

Finally, visit the file [path]_demo/index.html_ in your browser to see the plugin in action.
////

== Download

Download the {uri-raw-file-base}/dist/bespoke-onstage.min.js[production mode version] or the {uri-raw-file-base}/dist/bespoke-onstage.js[development mode version], or use a package manager.

=== npm

```bash
$ npm install bespoke-onstage
```

=== Bower

```bash
$ bower install bespoke-onstage
```

== Usage

This plugin is shipped in a https://github.com/umdjs/umd[UMD format], meaning it is available as a CommonJS/AMD module or as a browser global.

For example, when using CommonJS modules:

```js
var bespoke = require('bespoke'),
  onstage = require('bespoke-onstage');

bespoke.from('.deck', [
  onstage()
]);
```

When using a browser global:

```js
bespoke.from('.deck', [
  bespoke.plugins.onstage()
]);
```

Once the onstage plugin is added, open the file [path]_node_modules/bespoke-onstage/demo/onstage.html_ and enter the absolute URL to your presentation.
You will see a presenter console that you can use to drive the presentation in another browser window.

Launch the presentation window by clicking on btn:[Launch].

== License

http://en.wikipedia.org/wiki/MIT_License[MIT License]
{'fraction_non_alphanumeric': 0.12655836796373252, 'fraction_numerical': 0.0, 'mean_word_length': 4.687432867883996, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 17, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2672386', 'n_tokens_mistral': 1786, 'n_tokens_neox': 1716, 'n_words': 497}