larstvei/ox-gfm
1
0
Fork 0
mirror of https://github.com/larstvei/ox-gfm.git synced 2024-11-26 01:28:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add usage to README

Browse Source
This commit is contained in:
Christopher Bui 2017-02-13 19:03:40 -06:00 committed by Chris Bui
parent 0741216c63
commit 36f1b03025
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -9,3 +9,30 @@ Org mode. It should support the features [listed here](https://help.github.com/a
You can install `ox-gfm` using elpa. It's available on [melpa](http://melpa.org/#/ox-gfm):
<kbd> M-x package-install ox-gfm </kbd>
## Usage
This package adds an Org mode export backend for GitHub Flavored Markdown.
You can read more about [Org mode exporting here.](http://orgmode.org/manual/Exporting.html)
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:
```emacs-lisp
(require 'ox-gfm)
```
If you want to automatically enable exporting to Github Flavored Markdown, you
can add this snippet in your emacs config:
```emacs-lisp
(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](http://orgmode.org/manual/The-export-dispatcher.html#The-export-dispatcher).
You can use the exporter with `C-c C-e` or `M-x org-export-dispatch`