https://github.com/matmoore/markdown-external-link-finder
Find external links in markdown files
https://github.com/matmoore/markdown-external-link-finder
Last synced: 4 months ago
JSON representation
Find external links in markdown files
- Host: GitHub
- URL: https://github.com/matmoore/markdown-external-link-finder
- Owner: MatMoore
- License: mit
- Created: 2019-05-27T19:18:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-28T22:15:32.000Z (about 5 years ago)
- Last Synced: 2025-03-15T23:37:15.265Z (about 1 year ago)
- Language: Python
- Size: 14.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown external link finder
[](https://circleci.com/gh/MatMoore/markdown-external-link-finder)
This tool looks for external links in markdown files.
Currently this identifies external URLs that are linked to in a markdown file, ignoring any relative URLs.
## Installing
This tool requires Python 3.6 or later. To install with pip:
`pip install markdown-external-link-finder`
## Usage
Run `python -m markdown_external_link_finder` in the directory you want to search.
This outputs a list of URLs, one per line.
## Python API
`extract_markdown_links` takes a list of filenames and returns a list of URLs.
Example usage:
```python
from markdown_external_link_finder.extract import extract_markdown_links
for url in extract_markdown_links(['/path/to/file.md']):
print(url)
```
## Versioning
This project follows [Semantic Versioning](https://semver.org/).
### Releasing a new version
1. Update the changelog (TODO: add the changelog)
2. Update the version in `setup.py`
3. Tag the repo with `vX.Y.Z` where X.Y.Z is the version
4. CircleCI will automatically build the package and release to PyPI
## Licence
MIT