Skip to content

Commit

Permalink
Update README.md and CHANGES.md
Browse files Browse the repository at this point in the history
Add documentation and notes related to issue GH-255 and the patch in
GH-264.
  • Loading branch information
jrblevin committed Sep 25, 2017
1 parent ee7a3a5 commit 35441cf
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@

* Improvements:

- Allow `markdown-command` and `markdown-open-command` to be
functions. ([GH-255][], [GH-263][])

* Bug fixes:

- Remove GFM checkbox overlays when switching major modes.
Expand All @@ -28,11 +31,13 @@
[gh-246]: https://github.com/jrblevin/markdown-mode/issues/246
[gh-252]: https://github.com/jrblevin/markdown-mode/pull/252
[gh-254]: https://github.com/jrblevin/markdown-mode/issues/254
[gh-255]: https://github.com/jrblevin/markdown-mode/issues/255
[gh-257]: https://github.com/jrblevin/markdown-mode/pull/257
[gh-258]: https://github.com/jrblevin/markdown-mode/pull/258
[gh-259]: https://github.com/jrblevin/markdown-mode/pull/259
[gh-260]: https://github.com/jrblevin/markdown-mode/pull/260
[gh-261]: https://github.com/jrblevin/markdown-mode/pull/261
[gh-263]: https://github.com/jrblevin/markdown-mode/pull/263

# Markdown Mode 2.3

Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,10 @@ provides an interface to all of the possible customizations:

* `markdown-command` - the command used to run Markdown (default:
`markdown`). This variable may be customized to pass
command-line options to your Markdown processor of choice.
command-line options to your Markdown processor of choice. It can
also be a function; in this case `markdown` will call it with three
arguments: the beginning and end of the region to process, and
a buffer to write the output to.

* `markdown-command-needs-filename` - set to `t` if
`markdown-command` does not accept standard input (default:
Expand All @@ -572,7 +575,9 @@ provides an interface to all of the possible customizations:
When set to `t`, `markdown-mode` will pass the name of the file
as the final command-line argument to `markdown-command`. Note
that in the latter case, you will only be able to run
`markdown-command` from buffers which are visiting a file.
`markdown-command` from buffers which are visiting a file. If
`markdown-command` is a function, `markdown-command-needs-filename`
is ignored.

* `markdown-open-command` - the command used for calling a standalone
Markdown previewer which is capable of opening Markdown source files
Expand All @@ -581,6 +586,8 @@ provides an interface to all of the possible customizations:
A representative program is the Mac app [Marked 2][], a
live-updating Markdown previewer which can be [called from a
simple shell script](https://jblevins.org/log/marked-2-command).
This variable can also be a function; in this case `markdown-open`
will call it without arguments to preview the current buffer.

* `markdown-hr-strings` - list of strings to use when inserting
horizontal rules. Different strings will not be distinguished
Expand Down

0 comments on commit 35441cf

Please sign in to comment.