mirror of
https://github.com/not-kennethreitz/markdownplease.com.git
synced 2026-06-05 23:20:19 +00:00
Gilberto Gonçalves
42 lines
1007 B
Markdown
42 lines
1007 B
Markdown
# url2markdown
|
|
|
|
This is a very simple web service that will take a given URL, and return
|
|
a Markdown representation of that page.
|
|
|
|
Powered by [Readability](http://readability.com/),
|
|
[Requests](http://python-guide.org/),
|
|
[html2text](http://www.aaronsw.com/2002/html2text/),
|
|
[markdown](http://pythonhosted.org/Markdown/),
|
|
and [Flask](http://flask.pocoo.org/).
|
|
|
|
## Usage
|
|
|
|
|
|
$ curl http://url2markdown.herokuapp.com/?url=http://kennethreitz.org
|
|
|
|
# Hi, there.
|
|
|
|
My name is Kenneth Reitz.
|
|
...
|
|
|
|
Or, if you understand code:
|
|
|
|
$ mkvirtualenv url2markdown
|
|
$ pip install -r requirements.txt
|
|
$ READABILITY_TOKEN="XXX" python service.py
|
|
|
|
Enjoy!
|
|
|
|
## Configuration
|
|
|
|
This application requires a [Readability Parser Token](http://www.readability.com/developers/api/parser).
|
|
|
|
$ export READABILITY_TOKEN=xxxxxx
|
|
|
|
You can use [autoenv](https://github.com/kennethreitz/autoenv) to do this easily.
|
|
|
|
## License
|
|
|
|
Unfortunately, this code is released under [GPLv3](http://www.gnu.org/copyleft/gpl.html).
|
|
|