Skip to main content

Convert Markdown to the Gemini text format

Project description


Converter from Markdown to the Gemini text format. It works as a Python module, or a command line application.


pip3 install md2gemini

You may also want to use the --user flag after install, to only install the package for your user.

Note that this package only officially supports Python 3.


It works directly in Python, or on the command line. The command line version can work with unix pipes as well, reading files from stdin and writing to stdout if desired.

Command line

usage: md2gemini [-h] [--version] [-w] [-d DIR] [-a] [-j] [--img-tag IMG_TAG] [-i INDENT] [file [file ...]]

Convert markdown to gemini.

positional arguments:
  file                  Files to convert. If no files are specified then data will be read from stdin and printed to stdout.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -w, --write           Write output to a new file of the same name, but with a .gmi extension.
  -d DIR, --dir DIR     The directory to write files to, if --write is used.
  -a, --ascii-table     Use ASCII to create tables, not Unicode.
  -j, --jekyll          Remove jekyll frontmatter from parsing and output.
  --img-tag IMG_TAG     What text to add after image links. Defaults to '[IMG]'. Write something like --img-tag='' to remove it.
  -i INDENT, --indent INDENT
                        The number of spaces to use for list indenting. Put 'tab' to use a tab instead.

In Python

from md2gemini import md2gemini
# Load a markdown file's contents into memory and get conversion
with open("", "r") as f:
    gemini = md2gemini(
# Now the gemini variable contains your converted text as a string

Options for the md2gemini function are similar to the command line ones above.

def md2gemini(markdown, img_tag="[IMG]", indent="  ", ascii_table=False, jekyll=False):
    """Convert the provided markdown text to the gemini format.

    img_tag: The text added after an image link, to indicate it's an image.

    indent: How much to indent sub-levels of a list. Put several spaces, or \\t for a tab.

    ascii_table: Use ASCII to create tables, not Unicode.

    jekyll: Skip jekyll frontmatter when processing.

Features to add

  • Footnote style links
    • Right now, inline links are converted to Gemini links, breaking up paragraph flow. It'd be better to have an option that just adds a footnote like [2] beside the word, and adds links at the end of the paragraph or document.

Project details

Download files

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

Files for md2gemini, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size md2gemini-1.0.0.tar.gz (17.9 kB) File type Source Python version None Upload date Hashes View
Filename, size md2gemini-1.0.0-py3-none-any.whl (18.6 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page