From cd01aa0970e8836718731cb096a2c4c030423bd6 Mon Sep 17 00:00:00 2001 From: Lars Tveito Date: Wed, 15 Feb 2017 22:46:50 +0100 Subject: [PATCH] Simplify README usage section --- README.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 0a598c3..0f41794 100644 --- a/README.md +++ b/README.md @@ -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`