Skip to main content

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

Project description

Linkify GitHub Markdown

CI Status Test coverage percentage

uv Ruff pre-commit

PyPI Version Supported Python versions License


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
 Usage: linkify-gh-markdown [OPTIONS] INPUT_PATH

 Add the arguments and print the result.

╭─ Arguments ─────────────────────────────────────────────────────╮
│ *    input_path      TEXT  [required]                           │
╰─────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────╮
│ --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
Bruno Alla

💻 🤔 📖

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

Credits

Copier

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

linkify_gh_markdown-1.1.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

linkify_gh_markdown-1.1.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file linkify_gh_markdown-1.1.0.tar.gz.

File metadata

  • Download URL: linkify_gh_markdown-1.1.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for linkify_gh_markdown-1.1.0.tar.gz
Algorithm Hash digest
SHA256 7579d31de293d06bf5ead27c5da498853a41452f17041c2fda307b13286ffe43
MD5 501763fea4fd4156b6683b705be4256c
BLAKE2b-256 dd032ab32227dc7bcb179697992ce34a418ac73a7e6a36d5e2390a8b9b4da824

See more details on using hashes here.

Provenance

The following attestation bundles were made for linkify_gh_markdown-1.1.0.tar.gz:

Publisher: ci.yml on browniebroke/linkify-gh-markdown

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file linkify_gh_markdown-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for linkify_gh_markdown-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1d1e44fa80edbc9b194c4edccf392c1d38760c591b9ffa967bdbdaf244771f7
MD5 385b1598dcdc9257056e512a6ed3999e
BLAKE2b-256 e807e5ea70fa88dd70146bf7ff64fea9827cceb427aa6cdd647ae4c70e6816ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for linkify_gh_markdown-1.1.0-py3-none-any.whl:

Publisher: ci.yml on browniebroke/linkify-gh-markdown

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page