https://github.com/tecladocode/markdown-link-checker

A command-line utility that, given a markdown file, checks whether all its links work.
https://github.com/tecladocode/markdown-link-checker

Last synced: 4 months ago
JSON representation

A command-line utility that, given a markdown file, checks whether all its links work.

• Host: GitHub
• URL: https://github.com/tecladocode/markdown-link-checker
• Owner: tecladocode
• License: mit
• Created: 2021-11-26T10:44:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-26T17:06:28.000Z (over 4 years ago)
• Last Synced: 2024-10-05T03:28:48.271Z (almost 2 years ago)
• Language: Python
• Size: 6.84 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
[![PyPI version markdown-link-checker](https://badgen.net/badge/pypi%20version/0.1.0/green?icon=pypi)](https://pypi.python.org/pypi/markdown-link-checker/)

# Markdown Link Checker

A command-line utility written in Python that checks validity of links in a markdown file.

## Install

```

pip install markdown-link-checker

```

## Usage

```

link_checker "markdown-file.md"

```

## Output

Invalid links in document

| link             | reason                                                                                                                                                                                                                                                                    |

| :--------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| http://example.c | HTTPConnectionPool(host='example.c', port=80): Max retries exceeded with url: / (Caused by NewConnectionError(': Failed to establish a new connection: [Errno ] nodename nor servname provided, or not known')) |

| htp://google.com | No connection adapters were found for 'htp://google.com'                                                                                                                                                                                                                  |

| http//google.com | Invalid URL 'http//google.com': No schema supplied. Perhaps you meant http://http//google.com?                                                                                                                                                                            |

Valid links in document

| text  | link               |

| ----- | ------------------ |

| here  | http://example.com |

| Udemy | https://udemy.com  |