# dropout

> dropout

Latest version **1.0.2** (published 2017-10-28) · ISC license · 0 weekly downloads

## Install

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

Provides the command `dropout`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-10-28 |
| First published | 2017-10-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jondashkyle |

## Links

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

## Dependencies (8)

- [xtend](https://npm.io/package/xtend.md) ^4.0.1
- [yargs](https://npm.io/package/yargs.md) ^10.0.3
- [time-stamp](https://npm.io/package/time-stamp.md) ^2.0.0
- [create-html](https://npm.io/package/create-html.md) ^4.0.0
- [normalize-url](https://npm.io/package/normalize-url.md) ^1.9.1
- [object-values](https://npm.io/package/object-values.md) ^1.0.0
- [node-readability](https://npm.io/package/node-readability.md) ^3.0.0
- [github-markdown-css](https://npm.io/package/github-markdown-css.md) ^2.9.0

## Recent versions

- 1.0.2 (latest) — 2017-10-28
- 1.0.1 — 2017-10-28
- 1.0.0 — 2017-10-26

## README

<h1 align="center">dropout</h1>

<p align="center"><a href="https://www.are.na/emma-rae-norton/big-data-no-thanks"><img align="center" src="https://d2w9rnfcy7mm78.cloudfront.net/989416/large_763dc9142432e03b75e5c9362c12031b.jpg" width="100" height="auto"></a></p>

When interfaces are designed for capturing and exhausting your attention going offline is both an act of liberation and luxury. This is a tool of ethical technology enabling you to save pages for offline access and personal archival.

```
npm install dropout -g

dropout save http://quillette.com/2017/10/22/liberals-turning-internet/
```

## features

- Cleanup a page to showcase only the content
- Static files, no database, so super extendable
- Platforms 🖕, this is a tool 🎉

## usage

You can use either the [command line interface](#cli) or the [module](#module) with js. There are plans for other things, too.

## cli

```
dropout <cmd> [args]

Commands:
  dropout save [url]  save a url

Options:
  --version  Show version number
  --help     Show help
```

## module

```
var dropout = require('dropout')
```

### `dropout.save(url, {options})`

Save a page! Creates an `index.html` for easy viewing, and a `data.json` with some handy meta-data and the parsed content which is used to generate the html.

## options

### `options.fs`

Pass a custom filesystem for saving. Expects `mkdirSync`, `writeFileSync`.

### `options.output`

The output (parent) directory the page directory will be saved to.

### `options.prepend`

Prepend the directory name with a custom [timestamp](https://www.npmjs.com/package/time-stamp). Defaults to `YYMMDD`.

### `options.style`

The CSS for the document. Currently defaults to [Github Markdown CSS](https://github.com/sindresorhus/github-markdown-css).

### `options.template`

A custom template with `{{TITLE}}` and `{{CONTENT}}` tags. The default is currently gnarly.

```
<main class="markdown-body" style="max-width: 888px; margin: 60px auto;"><h1>{{TITLE}}</h1>{{CONTENT}}</main>
```

## related

- [`new-work`](https://github.com/s3ththompson/new-work), a CLI tool that automatically checks artists' websites for new work by Seth Thompson.
- [Hardly Everything](http://hardlyeverything.com), an attempt to subvert the traditional feed by substituting activity with user-defined durations of passing time called rests.

## todo

- [ ] Testing
- [ ] Save media files (img, youtubedl, etc)
- [ ] Custom CSS
- [ ] Custom HTML template
- [ ] Toggle page cleanup
- [ ] Reading interface
- [ ] Dat sync
- [ ] Beaker Browser app (hosted micro-service to save when online)
- [ ] `remove` lib method
- [ ] Add to [Arena](https://are.na) support

## change log

### 10/26/17

First release. Only the save functionality is there. Minimal documentation.

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