texmd 0.0.2

A simple library that translates LaTeX to Markdown.

texmd

A small library that converts LaTeX to Markdown. This package uses pylatexenc to parse the LaTeX expressions.

Installation

Run pip install texmd in the terminal.

Usage

This package allows you to load a .tex file directly.

from texmd import texmd # Import the package

file_path = "<PATH_TO_TEX_FILE>"
tex_file = texmd.load_file(file_path)

The loaded file tex_file is type of texmd.texmd.TexDocument.

If you want to parse the LaTeX string directly you can also do

tex_expr = "<TEX_EXPR>"
tex_file = texmd.parse(tex_expr)

We can convert then it to Markdown by

document = tex_file.to_md()

The output document is type of texmd.md.MdDocument. To output the document as Markdown syntax we can do

md = document.to_str()

and you can write it to a .md file.

Customization

If you don't like the way the package write the Markdown, or you want to support custom LaTeX expressions, you can use the API texmd.texmd.add_converter with a specific type from the package pylatexenc.