add a README
This commit is contained in:
parent
5937b44f73
commit
f61f1e080c
|
@ -0,0 +1,38 @@
|
|||
- url2markdown
|
||||
|
||||
url2markdown lets you download an URL and save it as a Markdown file.
|
||||
Additionally you can provide a list of tags which will get added to the top of
|
||||
the file. The main idea behind the script is to download articles and feed them
|
||||
to an Obsidia.md vault already extended with internal Obsidian links.
|
||||
|
||||
```
|
||||
url2markdown https://docs.python.org/3/howto/argparse.html --tags=Python,CLI
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- Provide an URL on the command line.
|
||||
- Provide a text file with a list of URLs and tags.
|
||||
|
||||
## Installation
|
||||
|
||||
Install url2markdown by running:
|
||||
|
||||
```bash
|
||||
pip3 install url2markdown
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
- Issue Tracker: github.com/Nebucatnetzer/url2markdown/issues
|
||||
- Source Code: github.com/Nebucatnetzer/url2markdown
|
||||
|
||||
## Support
|
||||
|
||||
You can open an issue at the Github repository however I don't garantee any
|
||||
support whatsever since this is a fully personal project more seen as an
|
||||
excersice.
|
||||
|
||||
## License
|
||||
|
||||
The project is licensed under the GPLv3 license.
|
Loading…
Reference in New Issue