Linkify GitHub Markdown

Source Code: https://github.com/browniebroke/linkify-gh-markdown

Turn URLs and handles in GitHub markdown into actual links to GitHub issues, pull requests or user profiles.

Installation

Install this via pip (or your favourite package manager):

pip install linkify-gh-markdown

Usage

This tool processes a markdown file and converts plain text GitHub references into proper markdown links:

• @username mentions become [@username](https://github.com/username)
• Pull request URLs like https://github.com/owner/repo/pull/123 become [#123](https://github.com/owner/repo/pull/123)

The result is printed to stdout.

linkify-gh-markdown path/to/file.md

Use --heading-level to shift all headings so the top-level heading in the output is at the given level (1–6):

linkify-gh-markdown --heading-level 2 path/to/file.md

 Usage: linkify-gh-markdown [OPTIONS] INPUT_PATH

 Add the arguments and print the result.

╭─ Arguments ─────────────────────────────────────────────────────╮
│ *    input_path      TEXT  [required]                           │
╰─────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────╮
│ --heading-level     INTEGER RANGE [1<=x<=6]                     │
│                             Set the top heading level in the    │
│                             output (1-6).                       │
│ --install-completion        Install completion for the current  │
│                             shell.                              │
│ --show-completion           Show completion for the current     │
│                             shell, to copy it or customize the  │
│                             installation.                       │
│ --help                      Show this message and exit.         │
╰─────────────────────────────────────────────────────────────────╯

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Bruno Alla 💻 🤔 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This package was created with Copier and the browniebroke/pypackage-template project template.