Skip to content
 
 

Latest commit

 

History

967 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

The Markdown package provides facilities for the conversion of markdown markup to plain TeX. These are provided both in the form of a Lua module and in the form of plain TeX, LateX, and ConTeXt macro packages that enable the direct inclusion of markdown documents inside TeX documents.

This material is subject to the LaTeX Project Public License.

Installation

To install the package, interpret the markdown.ins file using a Unicode-aware TeX engine, such as XeTeX (xetex markdown.ins) or LuaTeX (luatex markdown.ins). This should produce the following files:

  • markdown.lua -- The Lua module
  • markdown.tex -- The plain TeX macro package
  • markdown.sty -- The LaTeX package
  • t-markdown.tex -- The ConTeXt module

Local installation

To perform a local installation, place these files into your TeX directory structure. This is generally where the individual files should be placed:

  • <TEXMF>/tex/luatex/markdown/markdown.lua
  • <TEXMF>/tex/generic/markdown/markdown.tex
  • <TEXMF>/tex/latex/markdown/markdown.sty
  • <TEXMF>/tex/context/third/markdown/t-markdown.tex

where <TEXMF> corresponds to a root of your TeX distribution, such as /usr/share/texmf and ~/texmf on UN*X systems or c:\users\<YOUR USERNAME>\texmfhome on Windows systems. When in doubt, consult the manual of your TeX distribution.

Portable installation

Alternatively, you can also store the markdown.lua, markdown.tex, markdown.sty and t-markdown.tex in the same folder as your TeX document and distribute them together. This way your document can be portably typeset on legacy TeX distributions.

Further information

For further information, consult the package documentation, which can be typeset by running the LaTeXMK tool on the markdown.dtx file (latexmk -pdf markdown.dtx). LaTeXMK should be included in your TeX distribution. The typeset documentation will reside in the file markdown.pdf.

About

A pack­age for con­vert­ing and ren­der­ing Mark­down doc­u­ments in­side TeX

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages