mirror/crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-09-28 07:09:40 +02:00
Code Issues

Update instructions on running crowbook from emacs

Browse Source
This commit is contained in:
Elisabeth Henry 2016-12-20 21:30:44 +01:00
parent 089034efe1
commit 5e0d9540b3
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
guide/misc.md
View File

@ -12,8 +12,7 @@ It is possible to use Crowbook for HTML previewing in this mode, which
```lisp
(custom-set-variables
'(markdown-command "crowbook -qs --to html --output /dev/stdout")
'(markdown-command-needs-filename t))
'(markdown-command "crowbook - -qs --to html --output -"))
```
You can then use `markdown-preview` (or `C-c C-c p`) to run
@ -27,16 +26,15 @@ We set `markdown-command` to `crowbook`, the reason for this is a bit
obvious. The arguments we give to crowbook might be a bit less
obvious:
* the fist argument, `-`, is actually the book file: it tells
`crowbook` to read it from standard input.
* `-qs` or `--quiet --single` tells Crowbook that is a a standalone
markdown file, and not a book configuration file, and to be a bit
quiet on error/info messages;
* `--to html` specifies that HTML must be generated;
* `--output /dev/stdout` forces Crowbook to display the result on the
* `--output -` tells Crowbook to display the result on the
stdout, even if you set `output.html` to `some_file.html`.
Also, `(markdown-command-needs-filename t)` is because at this point
Crowbook can't read from the stdin and must be specified a file.
### Limitations
While it renders correctly, this only works really nicely on standalone