Skip to main content

A Python-Markdown extension for styling variable types in-line

Project description

Python Markdown Extension: typehint

An extension for Python-Markdown. Replaces [@TYPENAME] text with styled "bubble" with a unique color.

Example Input

## Uppercase

[@ANY]
[@ARRAY]
[@BOOLEAN]
[@CLASS]
[@DATE]
[@ELEMENT]
[@FLOAT]
[@FUNCTION]
[@INT]
[@NUMBER]
[@OBJECT]
[@REGEXP]
[@STRING]

## Title Case

[@Any]
[@Array]
[@Boolean]
[@Class]
[@Date]
[@Element]
[@Float]
[@Function]
[@Int]
[@Number]
[@Object]
[@RegExp]
[@String]

## Lower Case

[@any]
[@array]
[@boolean]
[@class]
[@date]
[@element]
[@float]
[@function]
[@int]
[@number]
[@object]
[@regexp]
[@string]

## Custom

[@any any]
[@array \[\]]
[@boolean true]
[@class MyClass]
[@date myDate]
[@element HTMLElement]
[@float 4.32]
[@function myFunction]
[@int 32]
[@number myNumber]
[@object {}]
[@regexp myRegex]
[@string 'testing']

Example Output

example_output

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

pymdown-typehint-0.2.0.tar.gz (3.4 kB view hashes)

Uploaded Source

Built Distribution

pymdown_typehint-0.2.0-py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 3

Supported by

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