Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rumpl/md-read
Save articles on the web in Markdown
https://github.com/rumpl/md-read
Last synced: about 2 months ago
JSON representation
Save articles on the web in Markdown
- Host: GitHub
- URL: https://github.com/rumpl/md-read
- Owner: rumpl
- Created: 2013-03-20T10:05:06.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-03-22T21:41:01.000Z (almost 12 years ago)
- Last Synced: 2024-10-31T03:12:04.819Z (3 months ago)
- Language: JavaScript
- Size: 108 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# md-read
Save articles on the web in Markdown.
`md-read` uses node-readability to extract an article from a web page and saves it to disk in Markdown format for
you to read later.## Installation
```
npm install -g md-read
```## Configuration
When first run it will create an .md-read.json file with the current directory as the default path for saving
articles.The configuration is a simple json file with one key :
```javascript
{
"directory": "/some/path"
}
```Tip : put it in Dropbox for a free personal distributed read-it-later service.
## Usage
```
md-read
```And it will save the file in the current directory in Markdown format
## License
[MIT](http://mit-license.org/rumpl)