Welcome to MultiMarkdown to LyX.

While the information below is an introduction to MultiMarkdown to LyX, please make sure to read this full documentation in order to understand the difference between the LyX version and standard MultiMarkdown: MultiMarkdown to LyX PDF documentation (and the MultiMarkdown version).

How do I get MultiMarkdown to LyX?

MultiMarkdown to LyX has been incorporated, by Fletcher T. Penny, into MultiMarkdown. You should download a copy of MultiMarkdown from his web page and refer to his documentation on installation. In addition, please refer to the MultiMarkdown to LyX documentation (above) for the LyX specifics.

What is MultiMarkdown to LyX?

MultiMarkdown to LyX is an enhancement to MultiMarkdown that allows the production of a .lyx file. These files can be opened directly in LyX. As described on their web page:

LyX is a document processor that encourages an approach to writing based on the structure of your documents (WYSIWYM) and not simply their appearance (WYSIWYG).

LyX combines the power and flexibility of TeX/LaTeX with the ease of use of a graphical interface. This results in world-class support for creation of mathematical content (via a fully integrated equation editor) and structured documents like academic articles, theses, and books. In addition, staples of scientific authoring such as reference list and index creation come standard. But you can also use LyX to create a letter or a novel or a theatre play or film script. A broad array of ready, well-designed document layouts are built in. (http://www.lyx.org)

MultiMarkdown already provides LaTeX support, so you may ask, why provide LyX output? There are two key areas where LyX stands out:

1. Editing and "Tweaking" the LaTeX product. While MultiMarkdown is powerful, it can’t support all of the capabilities of LaTeX. LyX provides a structured editing environment that will allow modifications to the final output without being a LaTeX expert. In addition it will make it easier to adapt to other document classes, beyond Memoir and Beamer. For example, I really like this "Tufte- Handout" class.

   Inspired by Edward Tufte, author of four beautiful books on design: http://www.edwardtufte.com/tufte/. More information on the tufte-handout class here: http://wiki.lyx.org/Layouts/Tufte-handout

2. Easy choice of output formats. The view and export functions of LyX provide a large number of output choices to include PDF, postscript, DVI, different HTML formats, and rich text. For example, the output to HTML using eLyXer is very attractive.

Please note that the vast majority of my work has been using the LyX PDF (LuaTeX) output processor and have been successful. Given the packages utilized, with other output processors "your mileage may vary."

How do I use MultiMarkdown to LyX?

The LyX support is built into MultiMarkdown. You specify LyX output using the command line option -t or --to and specifying "lyx":

    multimarkdown -t lyx

In general, the metadata in the MultiMarkdown file will control the details of creating the .lyx file.

LaTeX Packages

Depending on the needs of the document class you are using and some of the metadata options, particular classes will be required.

MultiMarkdown to LyX assumes the following packages and will add them to the latex preamble of the LyX document settings dialog:

• listings -- used in formatting codeblocks
• natbib
• nomencl
• booktabs
• beamer-fragile (only if you are using Beamer)
• varioref -- to improve page references in links

Be sure that these packages are installed in your LaTeX configuration before you attempt to produce output from LyX.

In addition to the packages automatically included by MultiMarkdown, you can request that additional packages be added to this list via the Packages metadata entry.

Read the full documentation

As stated above, please make sure to read this full documentation in order to understand the difference between the LyX version and standard MultiMarkdown: MultiMarkdown to LyX PDF documentation