mirror_js/pagemap
1
0
Fork 0
mirror of https://github.com/lrsjng/pagemap.git synced 2025-09-01 17:12:36 +02:00
Code Issues Releases Wiki Activity

Initial commit.

Browse Source
This commit is contained in:
Lars Jung
2016-06-11 22:57:52 +02:00
commit 08d354a57b
12 changed files with 744 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
README.md Normal file
View File

@@ -0,0 +1,81 @@
# pagemap
[![license][license-img]][github] [![web][web-img]][web] [![github][github-img]][github] [![npm][npm-img]][npm]
[![version][npm-v-img]][npm] [![downloads][npm-dm-img]][npm] [![dependencies status][gemnasium-img]][gemnasium]
Mini map for web pages.
## Example usage
add a `canvas` tag to your HTML page:
```html
<canvas id='#map'></canvas>
```
fix it's position on the screen:
```css
#map {
position: fixed;
top: 0;
right: 0;
width: 200px;
height: 100%;
z-index: 100;
}
```
init and style the mini map:
```js
pagemap(document.querySelector('#map'), {
viewport: null,
styles: {
'header,footer,section,article': rgba(0,0,0,0.08),
'h1,a': rgba(0,0,0,0.10),
'h2,h3,h4': rgba(0,0,0,0.08)
},
back: rgba(0,0,0,0.02),
view: rgba(0,0,0,0.05),
drag: rgba(0,0,0,0.10),
interval: null
});
```
## License
The MIT License (MIT)
Copyright (c) 2016 Lars Jung (https://larsjung.de)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
[web]: https://larsjung.de/pagemap/
[github]: https://github.com/lrsjng/pagemap
[npm]: https://www.npmjs.org/package/pagemap
[gemnasium]: https://gemnasium.com/lrsjng/pagemap
[license-img]: https://img.shields.io/badge/license-MIT-a0a060.svg?style=flat-square
[web-img]: https://img.shields.io/badge/web-larsjung.de/pagemap-a0a060.svg?style=flat-square
[github-img]: https://img.shields.io/badge/github-lrsjng/pagemap-a0a060.svg?style=flat-square
[npm-img]: https://img.shields.io/badge/npm-pagemap-a0a060.svg?style=flat-square
[npm-v-img]: https://img.shields.io/npm/v/pagemap.svg?style=flat-square
[npm-dm-img]: https://img.shields.io/npm/dm/pagemap.svg?style=flat-square
[gemnasium-img]: https://img.shields.io/gemnasium/lrsjng/pagemap.svg?style=flat-square