Skip to content

Commit

Permalink
Docs site tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
artemave committed Jun 17, 2019
1 parent c393df0 commit dd006a9
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
- [Introduction](introduction)
- [Quick start](quickstart)
- [API Reference](api)
- **Links**
- [![Code](https://icongr.am/feather/code.svg?size=16&color=808080)Demo Sandbox](https://codesandbox.io/s/2x8kv8voyn?from-embed)
- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/featurist/browser-monkey)
- [![NPM](https://icongram.jgog.in/simple/npm.svg?colored&size=16)NPM](https://www.npmjs.com/package/browser-monkey)
8 changes: 6 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="reliable dom testing">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
</head>
<body>
<div id="app"></div>
Expand All @@ -28,11 +28,15 @@
noData: 'No Results!',
depth: 6,
hideOtherSidebarContent: false,
}
},
ga: window.location.hostname === 'localhost' ? '' : 'UA-34932868-7'
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0"></script>
<script src="//unpkg.com/docsify-copy-code"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
</body>
</html>
4 changes: 3 additions & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Browser Monkey is a DOM assertion library. It helps you write framework agnostic
- can simulate text entry and clicks.
- returns promises that resolve when the elements are found.

## Examples
## Example

_Due to recent Codesandbox changes, this example currently does not work in the browser (details https://github.com/codesandbox/codesandbox-client/issues/2019). You can still download the project and run it locally._

```js
import createMonkey from "browser-monkey/create";
Expand Down

0 comments on commit dd006a9

Please sign in to comment.