Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jondashkyle/dropout
save a page for offline access and archival
https://github.com/jondashkyle/dropout
Last synced: 5 days ago
JSON representation
save a page for offline access and archival
- Host: GitHub
- URL: https://github.com/jondashkyle/dropout
- Owner: jondashkyle
- License: apache-2.0
- Created: 2017-10-26T04:26:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-14T00:06:31.000Z (almost 7 years ago)
- Last Synced: 2024-10-30T00:36:18.667Z (10 days ago)
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 69
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-starred - jondashkyle/dropout - save a page for offline access and archival (others)
README
dropout
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 [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.root`
Specifies that the `options.output` directory will be the root directory, rather than parent. Requires `options.output`.
### `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.
```
{{TITLE}}
{{CONTENT}}
```
## 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.