Merge pull request #3210 from panchoh/develop

Fix inaccuracy in markdown docs
This commit is contained in:
Henrik Lissner 2020-05-24 22:50:41 -04:00 committed by GitHub
commit 11ce7cdaf2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions

View file

@ -119,15 +119,14 @@ installed through your OS's package manager:
* Features
** Markdown preview
~markdown-preview~ is bound to =SPC m p= (for Evil users) and =C-c l p= (for
non-evil users). This will open a preview of your compiled markdown document in
your browser.
~markdown-preview~ is bound to =<localleader> p=. This will open a preview of
your compiled markdown document in your browser.
Alternatively, you can use ~grip-mode~ through =+grip=.
* Configuration
** Changing how markdown is compiled
When ~markdown-preview~ is invoked (=SPC m b= or =C-c l b=), it consults
When ~markdown-preview~ is invoked (=<localleader> p=) it consults
~markdown-command~. Its default value (~#'+markdown-compile~) will consult
~+markdown-compile-functions~: a list of functions that take three arguments: the
start and end point in the current buffer to use as input, and an output buffer
@ -138,7 +137,8 @@ By default, the value of ~+markdown-compile-functions~ is:
#+BEGIN_SRC lisp
'(+markdown-compile-marked
+markdown-compile-pandoc
+markdown-compile-markdown)
+markdown-compile-markdown
+markdown-compile-multimarkdown)
#+END_SRC
These functions will attempt to use the marked, pandoc and markdown executables,

View file

@ -32,7 +32,7 @@ Runs `+markdown-compile-functions' until the first function to return non-nil,
otherwise throws an error."
(or (run-hook-with-args-until-success '+markdown-compile-functions
beg end output-buffer)
(user-error "No markdown program could be found. Install marked, pandoc or markdown.")))
(user-error "No markdown program could be found. Install marked, pandoc, markdown or multimarkdown.")))
;;;###autoload
(defun +markdown-compile-marked (beg end output-buffer)