Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use rollup instead of webpack #309

Merged
merged 21 commits into from
Jan 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/coverage/
/cypress/dummy/js/prism.js
/dist/
/docs/
/docs/
/src/scss/
27 changes: 20 additions & 7 deletions babel.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,29 @@ module.exports = function(api) {

return {
presets: [
['@babel/preset-env']
],
plugins: [
'add-module-exports',
'lodash',
'transform-es2015-modules-commonjs'
[
'@babel/preset-env',
{
modules: false,
targets: {
browsers: 'ie >= 11'
}
}
]
],
env: {
test: {
plugins: ['istanbul']
presets: [
[
'@babel/preset-env',
{
modules: false
}
]
],
plugins: [
'transform-es2015-modules-commonjs'
]
}
}
};
Expand Down
3 changes: 0 additions & 3 deletions cypress.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
{
"coverageFolder": "coverage",
"fixturesFolder": "test/cypress/fixtures",
"integrationFolder": "test/cypress/integration",
"pluginsFile": "test/cypress/plugins/index.js",
"supportFile": "test/cypress/support/index.js",
"video": false,
"baseUrl": "http://localhost:9002"
}
262 changes: 0 additions & 262 deletions docs/welcome/css/welcome.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/welcome/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<meta name="theme-color" content="#ffffff">

<!-- Welcome docs styles -->
<link rel="stylesheet" href="/shepherd/dist/css/shepherd-theme-default.css"/>
<link rel="stylesheet" href="/shepherd/docs/welcome/css/prism.css"/>
<link rel="stylesheet" href="/shepherd/docs/welcome/css/welcome.css"/>
</head>
Expand Down
129 changes: 0 additions & 129 deletions docs/welcome/scss/welcome.scss

This file was deleted.

23 changes: 23 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,29 @@ Click Install to create a tour right on your site with no coding required.-->

<!--iframe style="height: 48px; width: 180px" src="//install.eager.io?appId=AalP5veMma6s" allowtransparency="true" scroll="no" frameBorder="0"></iframe-->

### Importing Shepherd into your app

#### Ember Apps

There is an official Ember Addon, [ember-shepherd](https://github.com/shipshapecode/ember-shepherd), for using Shepherd with Ember apps.

#### Rollup/Webpack Based Builds

The latest versions of Rollup and Webpack support ES6 imports. We have an ES module
exported to `dist/js/shepherd.esm.js`. This is also specified as `"module"` in
`package.json`, which should allow you to import using standard ES import syntax.

i.e.

```js
import Shepherd from 'shepherd.js';
```

#### GitHub Releases

Whenever we release a new version, the contents of the `dist` are uploaded
to the release in GitHub. You can find those assets [here](https://github.com/shipshapecode/shepherd/releases).

### Usage

First create a new `Tour` instance for your tour:
Expand Down
Loading