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 prek

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.2.0.tar.gz (10.4 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.2.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for linkify_gh_markdown-1.2.0.tar.gz
Algorithm Hash digest
SHA256 3b2f6f6386ab620f9adb23e0e83254ad972e233af7fa2f7df3358a951919df99
MD5 75c4fdc8489aa4ea200424e2cb07c23e
BLAKE2b-256 a8e5192c251d969880dd900b1f3107ac211ac68615836c97e2ad7f90ba7b4915

See more details on using hashes here.

Provenance

The following attestation bundles were made for linkify_gh_markdown-1.2.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.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for linkify_gh_markdown-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5201abbc37cdbc112f3a40753a049ef44866b8271594557fb1f6af25e32769a
MD5 f1832de4832b5326f90ebeeb38c0fe16
BLAKE2b-256 d51eae136c3e907933bfb63a0516cdf4b77dd8bc27ba7113b0462c2159f3060d

See more details on using hashes here.

Provenance

The following attestation bundles were made for linkify_gh_markdown-1.2.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