md - GitLite

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

md

★ 21 Open GitHub ↗

Convert md to html, pdf…

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# MD

## Description

MD is a [Thorfile](https://github.com/wycats/thor) to convert [Markdown](http://daringfireball.net/projects/markdown/syntax) files to HTML and PDF versions.

The real power of MD Thorfile is that it uses a customizable HTML layout and CSS.

Features:

- convert .md to .html with layout and CSS styling
- convert .md to .pdf with layout and CSS styling

## Installation

~~~bash
git clone git://github.com/synbioz/md.git
cd md
bundle install
thor md:setup # Copy default layout and css

thor install Thorfile
~~~

You can remove this clone since the Thorfile is installed system-wide.

## Usage

On the command-line:

~~~bash
$ thor md:generate my_markdown_file.md # Generates "my_markdown_file.html"
$ thor md:generate my_markdown_file.md -f pdf # Generates "my_markdown_file.pdf"
~~~

## Theme edition

When working on themes, you need to edit styles in `~/.config/md/themes/`.
To render the .pdf each time you update styles you can use a watch :

~~~bash
watch ./render.sh ~/.config/md/themes/**
~~~

## Settings and customization

MD can be configured through an `Mdfile` placed in directory where you launch the command.

`Mdfile`s have two purposes:

- Setting internal Markdown options through the `markdown_option` method,
- Extending the default Markdown renderer by supplying a block to the `renderer` method.

For details about options and custom renderers, have a look at the
[Redcarpet](https://github.com/vmg/redcarpet) docs.

Here is and example `Mdfile`:

~~~ruby
markdown_options no_links: true,
                 no_images: true

renderer do
  def block_code(code, language)
    "#{language}: <pre>#{code}</pre>"
  end
end
~~~

## Other

If you want to contribute or report bugs you should take a look at:

- [Homepage](https://github.com/synbioz/md)
- [Source Style](https://github.com/synbioz/guidelines/tree/ruby)
- [Ticket Guidelines](https://github.com/synbioz/md/wiki/TicketGuidelines)
- [Contributing](https://github.com/synbioz/md/wiki/Contributing)

Problems, comments, and suggestions are welcome on the [issue tracker](https://github.com/synbioz/md/issues).

## Authors

- Martin Catty (aka [\_fuse](https://twitter.com/_fuse))
- Nicolas Cavigneaux (aka [Bounga](https://twitter.com/Bounga))

md

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README