Skip to main content

A md-to-LaTeX converter

Project description

md2latex-converter introduction

pip install md2latex-converter

md2latex-converter is a Python package that helps to convert a .md (Markdown) file into a .tex (LaTeX) file, with special support for Chinese, using the ctex package provided by the LaTeX community.

md2latex-converter 是一个将 Markdown 文件转换成 LaTeX 源代码的 Python 工具包。使用了 LaTeX 的 ctex 包,因此对于 中文的编码环境有特别的关照。

Installation and Usage | 安装与使用

pip install md2latex-converter

This will install the package into your current python interpreter. The installation will add m2l.exe into the Scripts folder of python (on Windows) or m2l into ~/.local/bin/ by default (on Linux), if you have previously added the path above into your system PATH variable, you should be able to invoke the program through the command m2l.

这会在现有的 Python 解释器中安装此包。安装过程中会将 m2l.exe 安装在 当前的 Python 的 Scripts 路径(Windows)或默认将 m2l 安装到 ~/.local/bin/ 路径(Linux)。如果此前已经将这个路径加入了 PATH 变量, 那么可以通过 m2l 指令来运行此程序。

m2l file.md

This will read and convert the content in file.md into file.tex at the current working directory. After the conversion, use xelatex file to produce a .pdf file from the LaTeX source code.

The output filename depends on your input, for foo.md, m2l will produce foo.tex

这会读取并转换 file.md 的内容到当前工作路径的 file.tex 文件。在此之后,可以使用 xelatex file 来编译产生 pdf

输出的文件名由命令输入决定,对 foo.md 的转换会产生 foo.tex

Current progress and plans | 进度,安排

  • Currently m2l basically supports:

    • plain text,
    • title,
    • unordered/ordered lists,
    • pictures (please use a local path if you do so, otherwise you are being impolite to LaTeX.)
    • inline patterns
      • something bold
      • something italic
      • or something bold and italic
      • inline code snippets
      • hyperlinks
  • The future versions will focus on equations, codeblocks

  • Versions in the more distant future will support DIY markdown grammar and texify methods.

  • 现阶段支持了:

    • 文本
    • 标题
    • 有序无序列表
    • 图片(本地路径)
    • 行内样式
      • 粗体文本
      • 斜体文本
      • **又粗又斜**的文本(你为什么要这样干)
      • 代码片段
      • 超链接
  • 未来版本计划支持公式、代码块

  • 在更久远的未来,可以支持用户自定义md语法和 texify 方法

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

md2latex_converter-0.0.4.1.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

md2latex_converter-0.0.4.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file md2latex_converter-0.0.4.1.tar.gz.

File metadata

  • Download URL: md2latex_converter-0.0.4.1.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for md2latex_converter-0.0.4.1.tar.gz
Algorithm Hash digest
SHA256 fb44c286bbef711244f78ff5cc0873d11298cf123ea061712d231ab5e32820aa
MD5 04ff3fa52f8e7e431a1f7b2672642503
BLAKE2b-256 2ecdb5da268ed1126b1ee5694d7929aed952ff51ed40ad568fb30960c602a8f9

See more details on using hashes here.

File details

Details for the file md2latex_converter-0.0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for md2latex_converter-0.0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3c1def00b643a1c66f947b468f4916a23fd6d6a7a12ec0b22c84e14dc47b59bd
MD5 c8a4de48233bf9e3976b3e845b1b220a
BLAKE2b-256 111b89dcc06bc7d9e16f1a2bb40f95fdf9131b82d018309bd403f449b7a383df

See more details on using hashes here.

Supported by

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