https://github.com/cebe/markdown-latex

A markdown parser for converting markdown to LaTeX written in PHP.
https://github.com/cebe/markdown-latex

hacktoberfest latex markdown markdown-parser markdown-to-pdf php

Last synced: about 2 months ago
JSON representation

A markdown parser for converting markdown to LaTeX written in PHP.

• Host: GitHub
• URL: https://github.com/cebe/markdown-latex
• Owner: cebe
• License: mit
• Created: 2014-02-26T14:33:00.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2021-08-28T11:38:31.000Z (over 3 years ago)
• Last Synced: 2024-10-11T21:55:49.966Z (2 months ago)
• Topics: hacktoberfest, latex, markdown, markdown-parser, markdown-to-pdf, php
• Language: PHP
• Homepage:
• Size: 142 KB
• Stars: 48
• Watchers: 4
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
markdown-latex

==============

[![Latest Stable Version](https://poser.pugx.org/cebe/markdown-latex/v/stable.png)](https://packagist.org/packages/cebe/markdown-latex)

[![Total Downloads](https://poser.pugx.org/cebe/markdown-latex/downloads.png)](https://packagist.org/packages/cebe/markdown-latex)

[![Build Status](https://travis-ci.org/cebe/markdown-latex.svg?branch=master)](https://travis-ci.org/cebe/markdown-latex)

[![Code Coverage](https://scrutinizer-ci.com/g/cebe/markdown-latex/badges/coverage.png?s=db6af342d55bea649307ef311fbd536abb9bab76)](https://scrutinizer-ci.com/g/cebe/markdown-latex/)

[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/cebe/markdown-latex/badges/quality-score.png?s=17448ca4d140429fd687c58ff747baeb6568d528)](https://scrutinizer-ci.com/g/cebe/markdown-latex/)

A markdown parser for converting markdown to LaTeX written in PHP.

Implementation based on [cebe/markdown][].

[cebe/markdown]: https://github.com/cebe/markdown "A markdown parser for PHP"

Installation

------------

PHP 5.4 or higher is required to use it.

Installation is recommended to be done via [composer][] by adding the following to the `require` section in your `composer.json`:

```json

"cebe/markdown-latex": "*"

```

Run `composer update` afterwards.

[composer]: https://getcomposer.org/ "The PHP package manager"

Usage

-----

### In your PHP project

To use the parser as is, you just create an instance of a provided flavor class and call the `parse()`-

or `parseParagraph()`-method:

```php

// default markdown and parse full text

$parser = new \cebe\markdown\latex\Markdown();

$parser->parse($markdown);

// use github

$parser = new \cebe\markdown\latex\GithubMarkdown();

$parser->parse($markdown);

// parse only inline elements (useful for one-line descriptions)

$parser = new \cebe\markdown\latex\GithubMarkdown();

$parser->parseParagraph($markdown);

```

### The command line script

You can use it to render this readme:

    bin/markdown-latex README.md > output.tex

Using github flavored markdown:

    bin/markdown-latex --flavor=gfm README.md > output.tex

or convert the original markdown description to html using the unix pipe:

    curl http://daringfireball.net/projects/markdown/syntax.text | bin/markdown-latex > output.tex

To create a latex document you have to include the generated latex source in a latex document `main.tex`:

```tex

\documentclass[a4paper, 12pt]{article}

% english and utf8

\usepackage[british]{babel}

\usepackage[utf8]{inputenc}

% url support

\usepackage{url}

% make links clickable

\usepackage{hyperref}

% code listings

\usepackage{listings}

% include images

\usepackage{graphicx}

% better tables using tabularx

\usepackage{tabularx}

% support github markdown strikethrough

% http://tex.stackexchange.com/questions/23711/strikethrough-text

\usepackage{ulem}

\begin{document}

	\include{output.tex}

\end{document}

```

make a PDF with `pdflatex main.tex`.