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

Simplify README usage section

Browse Source
This commit is contained in:
Lars Tveito 2017-02-15 22:46:50 +01:00
parent 36f1b03025
commit cd01aa0970
1 changed files with 8 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -12,27 +12,18 @@ You can install `ox-gfm` using elpa. It's available on [melpa](http://melpa.org/
## Usage
This package adds an Org mode export backend for GitHub Flavored Markdown.
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)
You can read more about [Org mode exporting here.](http://orgmode.org/manual/Exporting.html)
Exporting to Github Flavored Markdown is available through Org
mode's [export dispatcher](http://orgmode.org/manual/The-export-dispatcher.html#The-export-dispatcher)
once `ox-gfm` is loaded. Alternatively, exporting can be triggered by calling the
(autoloaded) function `M-x org-gfm-export-to-markdown`.
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:
If you want to automatically load `ox-gfm` along with Org mode, then you can
add this snippet to your Emacs configuration:
```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`