# reading_view

> View web pages in a reading mode.

Latest version **0.3.0** (published 2016-02-23) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install reading_view
pnpm add reading_view
yarn add reading_view
bun add reading_view
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-02-23 |
| First published | 2015-07-15 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Artyom Fedenko |
| Maintainers | artie18 |
| Keywords | read , view, parse, js |

## Links

- npm: https://www.npmjs.com/package/reading_view
- Repository: https://github.com/Artie18/reading_view
- Homepage: https://github.com/Artie18/reading_view#readme
- Issues: https://github.com/Artie18/reading_view/issues
- npm.io page: https://npm.io/package/reading_view

## Dependencies (4)

- [jsdom](https://npm.io/package/jsdom.md) 5.6.x
- [mocha](https://npm.io/package/mocha.md) 2.2.x
- [request](https://npm.io/package/request.md) 2.x.x
- [check-types](https://npm.io/package/check-types.md) 3.0.x

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.3.0 (latest) — 2016-02-23
- 0.2.1 — 2015-07-23
- 0.2.0 — 2015-07-23
- 0.1.1 — 2015-07-20
- 0.1.0 — 2015-07-15

## README

# Reading View(reading_view)
_View web pages in a reading mode._

[![NPM](https://nodei.co/npm/reading_view.png)](https://nodei.co/npm/reading_view/)

## Desciption

io.js module for generating customisable easy to read html on the go.

This project can be found on NPM and installed through that.

**Important:** Project is in development stage, so big changes could be made!

**Example:** [readerview.mopso.co](http://readerview.mopso.co/demo/)

## Installation

`npm install reading_view`

## Current Version

`0.2.1`

## Using

#### Getting Started
```
var readingView = require('reading_view');

readingView.convert(url, params, callback);
```

#### Parametrs
###### Convert Function
|Paramert|Description| Type | 
|:-------|:-------|:-------|
|url     |URL of web page to convert into reading view| Url | 
|params  |Customisation Parametrs for convertation    | Object Params |
|callback|Function that is called when convertation is done, passes err - for errors, res - html string converted for reading| Function|

###### Params Object  in Convert Function
|Paramert|Description| Type | Default |
|:-------|:-------|:-------|:-------|
| articleQuery | JQuery stiled query to find current article body |String  | article |
| tagsToInclude | Each element is a JQuery stiled query to fetch elements inside main article | Array  | ['p','img'] |
| title | Parametrs to define title configuration | Object Title | 

###### Title Object 
|Paramert|Description| Type | Default |
|:-------|:-------|:-------|:-------|
|textOnly| Fetch only text from title without current tags |Boolean  | false|
|tagToWrap| Html tag name, that is wrapping title if *textOnly* is *true* |String|'h2'|
|query| JQuery styled query to fetch header in article, if there are more than one, fetches first | String | "${self.articleSelector} h${i}:first" _where i is Int from 1 to 6_ |

---
_Source: https://npm.io/package/reading_view · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._