readme; updated css theme

This commit is contained in:
Igor Shymko
2014-09-14 17:41:52 +03:00
parent 8dabbf2d62
commit 8454901b16
3 changed files with 34 additions and 10 deletions

View File

@@ -1,15 +1,39 @@
Markdown preview mode
===========================
Markdown mode extension with realtime preview. Minor mode.
## Description
Opens a preview in a browser, updated upon buffer save.
Same preview window is valid accross multiple mardown buffers.
Depends on:
## Dependencies
* markdown-mode
* markdown-mode.el
* websocket.el
table header 1 | header 2 | head 3
--------------|---------|------
cell1 | cell2 | cell3
cell1 | cell2 | cell3
cell1 | cell2 | [cell3](#asdfsadf)
Makes use of `markdown-mode`, which already can transform markdown into html
and `websocket.el` to deliver html to browser.
## Starting preview
`M-x markdown-preview-mode` will open preview in a browser and will start `markdown-mode` if it's not yet running for current buffer.
If you'v closed the preview window, you can start it over with
`M-x markdown-preview-open-browser`.
## Multimarkdown
In order to enable multimarkdown support, customize
`M-x customize-option` -> `markdown-command` variable.
Look for `Markdown Command` which is set to `markdown` by default,
set to `multimarkdown` and make sure it's in your PATH.
## Browser
In order to select prefered browser, customize
`M-x customize-option` -> `browse-url-browser-function` option.
Select your browser from `Value menu`. If it's not there, follow [EmacsWiki: Browse Url](http://www.emacswiki.org/emacs/BrowseUrl).
## Theme
[Solarized-dark](https://github.com/thomasf/solarized-css)