gh-md
A preprocessor for GitHub README files that allows simple expressions converted into markdown that pops.
Examples
Center
<center>
<h1>My Title</h1>
</center>
Renders as centered content.
Badge
<badge ltext="build" rtext="passing" color="green" />
Creates a shields.io badge. Supports ltext, rtext, style, logo, logoColor, labelColor, color, link, and href attributes.
Font
<font="mono">Monospace Text</font>
<font="double">Wide Text</font>
<font="Funky">Funky Text</font>
Applies ASCII art fonts to text. See gh_md/fonts.py for all available fonts (60+ options).
Projects
<projects user="vercel" limit="3" sort="stars">
<template>
{{ project.name }} - ⭐ {{ project.stargazers_count }}
</template>
</projects>
Fetches your GitHub repositories and renders them using a Jinja2 template. Requires user attribute. Optional: limit (default 3), sort (stars, updated, created).
Stats
<stats user="yourusername" show-icons count-private theme="transparent" hide-border />
Displays GitHub Readme Stats. Supports user, show-icons, count-private, hide-border, layout, base-url, route, and theme attributes.
Devicon
<devicon name="python" height="32" />
<devicon name="react" type="original" height="32" />
Inserts devicon icons. Requires name. Optional: type (original, plain, line), height.
Metadata
Release files for gh-md-action 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gh_md_action-1.0.0.tar.gz | 15.7 kB | Without provenance | Details for gh_md_action-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gh_md_action-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for gh_md_action-1.0.0-py3-none-any.whl |
Total release size: 31.0 kB
Release files / gh_md_action-1.0.0.tar.gz
| Download URL | gh_md_action-1.0.0.tar.gz |
|---|---|
| Size | 15.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
254526e3545d529a24ec2a68e6a7e8be37fb3a111783bdbdefa0cd60d91b02d3
|
|
BLAKE2b-256 checksum How to use checksums |
6abbca839048b830cc26ad52799c6c0d37f5630c2e962cf9cdc435ba87964dd7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / gh_md_action-1.0.0-py3-none-any.whl
| Download URL | gh_md_action-1.0.0-py3-none-any.whl |
|---|---|
| Size | 15.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7fdde8f9e80b0e05e5cc91e6297d72ecb4e96c1f8a6077ca48d74d61557ac883
|
|
BLAKE2b-256 checksum How to use checksums |
d3ed55c62f48179121c344c21b4f5e52c0567f631f9a4057aeefbe40b29329ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Security for gh-md-action 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.