Markmoji extends the basic markdown syntax using an easy to understand and quickly readable emoji-based syntax, allowing you to create custom HTML elements from just an emoji, a label and a URL.
Installing
Markmoji is on PyPi! To install, just copy the following into a terminal:
pip install markmoji
Click here for more instructions on what installing from pip means.
The Syntax
Similar to how basic markdown indicates an image using an exclamation point before a link (), markmoji syntax uses an emoji beore a link (🐦[name](url)), with the emoji dictating the type of HTML element created.
Python function
To parse markmoji syntax, just use the function markmoji.markmoji() with your markdown text as the input. It will return the same text but with any markmoji syntax returned as HTML objects.
Integration with python-markdown
Included in the package are the necessary classes to use markmoji as an extension to markdown.Markdown. Here's an example of how you might do it:
import markmoji
import markdown as md
# Define some dummy content
content = "🏐[label1](link1)\n🏐[label2](link2)/n🐦[label3](link3)"
# Create markdown processor with markmoji
processor = md.Markdown(extensions=[markmoji.Markmoji()])
# Do actual markdown conversion
content = processor.convert(content)
Contributing
This is all designed with open source contribution in mind! To add your own handlers, check out the file handlers/handlers.py to see the existing implementations and some instructions on how to add your own. It's not all that hard to do, I promise!
Metadata
Release files for markmoji 1.2.1
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 |
|---|---|---|---|---|
| markmoji-1.2.1.tar.gz | 11.0 kB | Without provenance | Details for markmoji-1.2.1.tar.gz |
Release files / markmoji-1.2.1.tar.gz
| Download URL | markmoji-1.2.1.tar.gz |
|---|---|
| Size | 11.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c8952664eda69248571dc9f2b4e26ebb4c71087256054c2e9a1c70762a4838b
|
|
BLAKE2b-256 checksum How to use checksums |
fc2d2680cd8e0628767253f84432e3b4a64a3c56057a2f250cb8b3a5dd2abdad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.11
|
Security for markmoji 1.2.1
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.