ox-gfm/README.md
2017-02-14 05:06:45 -06:00

1.2 KiB

MELPA

Github Flavored Markdown exporter for Org Mode

This is a small exporter based on the Markdown exporter already existing in Org mode. It should support the features listed here.

Installation

You can install ox-gfm using elpa. It's available on melpa:

M-x package-install ox-gfm

Usage

This package adds an Org mode export backend for GitHub Flavored Markdown.

You can read more about Org mode exporting here.

Org mode only loads these backends by default: ascii, html, icalendar, latex and odt

To manually enable this package you can simply require the package:

(require 'ox-gfm)

If you want to automatically enable exporting to Github Flavored Markdown, you can add this snippet in your emacs config:

(eval-after-load "org"
  '(require 'ox-gfm nil t))

Once the package is loaded you can use it in Org mode with the export dispatcher.

You can use the exporter with C-c C-e or M-x org-export-dispatch